c141455049
Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website. This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web. |
||
---|---|---|
.. | ||
README.rst | ||
account_validity.md | ||
delete_group.md | ||
event_reports.md | ||
media_admin_api.md | ||
purge_history_api.md | ||
purge_room.md | ||
register_api.md | ||
room_membership.md | ||
rooms.md | ||
server_notices.md | ||
shutdown_room.md | ||
statistics.md | ||
user_admin_api.md | ||
version_api.md |
README.rst
Admin APIs ========== **Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_. See `docs/README.md <../README.md>`_ for more information. **Please update links to point to the website instead.** Existing files in this directory are preserved to maintain historical links, but may be moved in the future. This directory includes documentation for the various synapse specific admin APIs available. Updates to the existing Admin API documentation should still be made to these files, but any new documentation files should instead be placed under `docs/usage/administration/admin_api <../usage/administration/admin_api>`_.