From 77e13626afeb4fcd0888144a0ddd3999aa58a7a3 Mon Sep 17 00:00:00 2001 From: Dragory <2606411+Dragory@users.noreply.github.com> Date: Mon, 25 May 2020 23:55:50 +0300 Subject: [PATCH] docs: add Snippets page, clean up Commands page --- README.md | 1 + docs/commands.md | 136 +++++++++++++++++++++++++++++++++++++--------- docs/snippets.gif | Bin 0 -> 13470 bytes docs/snippets.md | 53 ++++++++++++++++++ 4 files changed, 164 insertions(+), 26 deletions(-) create mode 100644 docs/snippets.gif create mode 100644 docs/snippets.md diff --git a/README.md b/README.md index 4863c7f..af4e399 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Inspired by Reddit's modmail system. * **[🛠️ Setting up the bot](docs/setup.md)** * [📝 Configuration](docs/configuration.md) * [🤖 Commands](docs/commands.md) +* [📋 Snippets](docs/snippets.md) * [🧩 Plugins](docs/plugins.md) * [🙋 Frequently Asked Questions](docs/faq.md) * [Release notes](CHANGELOG.md) diff --git a/docs/commands.md b/docs/commands.md index 397cf16..8e8f863 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,31 +1,115 @@ # 🤖 Commands +## Table of contents +* [Inside a ModMail thread](#inside-a-modmail-thread) +* [Anywhere on the inbox server](#anywhere-on-the-inbox-server) +* [Snippets (canned messages)](#snippets-canned-messages) + +## Inside a ModMail thread +These commands can only be used inside a ModMail thread's channel on the inbox server. + +### `!reply ` / `!r ` +Send a reply to the user. + +**Example:** `!r How can I help you?` + +To reply automatically without using `!reply`, [enable `alwaysReply` in bot settings](configuration.md). + +### `!anonreply ` / `!ar ` +Send an anonymous reply to the user. Anonymous replies only show the moderator's role in the reply. + +**Example:** `!ar Please only use ModMail for serious messages` + +### `!close` +Close the ModMail thread. + +### `!close