engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some wording tweaks/clarifications in docs

cshd
Dragory 2020-08-17 02:17:32 +03:00
parent ceff84a9ad
commit 15afd0995d
No known key found for this signature in database
GPG Key ID: 5F387BA66DF8AAC1
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -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`

2
docs/commands.md
View File

@ -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 <text>` / `!ar <text>`
Send an anonymous reply to the user. Anonymous replies only show the moderator's role in the reply.

8
docs/configuration.md
View File

@ -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"

2
docs/setup.md
View File

@ -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!