From 15afd0995d0db49508b724c24f04218e24d3c648 Mon Sep 17 00:00:00 2001 From: Dragory <2606411+Dragory@users.noreply.github.com> Date: Mon, 17 Aug 2020 02:17:32 +0300 Subject: [PATCH] Some wording tweaks/clarifications in docs --- CHANGELOG.md | 2 +- docs/commands.md | 2 +- docs/configuration.md | 8 ++++---- docs/setup.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1260963..f876876 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ Please report any bugs you encounter by [creating a GitHub issue](https://github * The supported versions are now 12, 13, and 14 * **BREAKING CHANGE:** The bot now requests the necessary [Gateway Intents](https://discord.com/developers/docs/topics/gateway#gateway-intents) * **This includes the privileged "Server Members Intent"**, which is used for server greetings/welcome messages. - This means that [**you need to enable "Server Members Intent"**](docs/server-members-intent.png) on the bot's page on the Discord Developer Portal. + This means that [**you need to turn on "Server Members Intent"**](docs/server-members-intent.png) on the bot's page on the Discord Developer Portal. * Renamed the following options. Old names are still supported as aliases, so old config files won't break. * `mainGuildId` => `mainServerId` * `mailGuildId` => `inboxServerId` diff --git a/docs/commands.md b/docs/commands.md index 2def0c0..dcd6bb3 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -13,7 +13,7 @@ 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). +To reply automatically without using `!reply`, [turn on `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. diff --git a/docs/configuration.md b/docs/configuration.md index b32912e..7267f3f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -32,10 +32,10 @@ You can add comments in the config file by prefixing the line with `#`. Example: option = value ``` -### Toggle options -Some options like `allowMove` are "**Toggle options**": they control whether certain features are enabled (on) or not (off). -* To enable a toggle option, set its value to `on`, `true`, or `1` -* To disable a toggle option, set its value to `off`, `false`, or `0` +### Toggled options +Some options like `allowMove` can only be turned on or off. +* To turn on a toggled option, set its value to `on`, `true`, or `1` +* To turn off a toggled option, set its value to `off`, `false`, or `0` * E.g. `allowMove = on` or `allowMove = off` ### "Accepts multiple values" diff --git a/docs/setup.md b/docs/setup.md index 487f868..fc0fbf3 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -13,7 +13,7 @@ To keep it online, you need to keep the bot process running. ## Prerequisites 1. Create a bot on the [Discord Developer Portal](https://discordapp.com/developers/) -2. Enable **Server Members Intent** in the bot's settings page on the developer portal ([Image](server-members-intent.png)) +2. Turn on **Server Members Intent** in the bot's settings page on the developer portal ([Image](server-members-intent.png)) 3. Install Node.js 12, 13, or 14 4. Download the latest bot version from [the releases page](https://github.com/Dragory/modmailbot/releases) * Make sure the release doesn't say "Pre-release" next to it unless you want to run an unstable beta version!