summary refs log tree commit diff
path: root/develop/admin_api/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'develop/admin_api/README.rst')
-rw-r--r--develop/admin_api/README.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/develop/admin_api/README.rst b/develop/admin_api/README.rst
new file mode 100644
index 0000000000..37cee87d32
--- /dev/null
+++ b/develop/admin_api/README.rst
@@ -0,0 +1,14 @@
+Admin APIs
+==========
+
+**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_.
+See `docs/README.md <../docs/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 <../docs/usage/administration/admin_api>`_.
+