From a028049e6f5338ecadc9fb0fbf061b06a3677487 Mon Sep 17 00:00:00 2001 From: Ginger Date: Mon, 12 Jan 2026 10:17:43 -0500 Subject: [PATCH] feat: Add copy to admin command reference index --- docs/reference/admin/index.md | 12 ++++++++++-- xtask/templates/admin/index.md | 12 ++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/reference/admin/index.md b/docs/reference/admin/index.md index 9f724f02..7517497b 100644 --- a/docs/reference/admin/index.md +++ b/docs/reference/admin/index.md @@ -1,7 +1,15 @@ -# Admin Commands +# Admin Command Reference -These are all the admin commands. TODO fill me out +Admin commands allow server administrators to manage the server from within their Matrix client. "Server administrators" by default means only those users which are members of the admin room, but additional server admins may be added using the `admins_list` configuration option. + +## Running commands + +* All commands listed here may be used by server administrators in the admin room by sending them as messages. +* If the `admin_escape_commands` configuration option is enabled, server administrators may run certain commands in public rooms by prefixing them with a single backslash. These commands will only run on _their_ homeserver, even if they are a member of another homeserver's admin room. Some sensitive commands cannot be used outside the admin room and will return an error. +* All commands listed here may be used in the server's console, if it is enabled. Commands entered in the console do not require the `!admin` prefix. + +## Categories - [`!admin appservices`](appservices/) - Commands for managing appservices - [`!admin users`](users/) - Commands for managing local users diff --git a/xtask/templates/admin/index.md b/xtask/templates/admin/index.md index 33813311..17f4eb6a 100644 --- a/xtask/templates/admin/index.md +++ b/xtask/templates/admin/index.md @@ -1,6 +1,14 @@ -# Admin Commands +# Admin Command Reference -These are all the admin commands. TODO fill me out +Admin commands allow server administrators to manage the server from within their Matrix client. "Server administrators" by default means only those users which are members of the admin room, but additional server admins may be added using the `admins_list` configuration option. + +## Running commands + +* All commands listed here may be used by server administrators in the admin room by sending them as messages. +* If the `admin_escape_commands` configuration option is enabled, server administrators may run certain commands in public rooms by prefixing them with a single backslash. These commands will only run on _their_ homeserver, even if they are a member of another homeserver's admin room. Some sensitive commands cannot be used outside the admin room and will return an error. +* All commands listed here may be used in the server's console, if it is enabled. Commands entered in the console do not require the `!admin` prefix. + +## Categories {%~ for category in categories %} - [`!admin {{ category.name }}`]({{ category.name }}/) {{ category.description }}