Skip to content

Commit 90278a4

Browse files
committed
Fix broken links and grammar, misc. edits
1 parent af066a4 commit 90278a4

20 files changed

+55
-51
lines changed

advanced/list-of-log-names.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: On this page all the available logs are listed
66

77
# List of Log Names
88

9-
Logs, categorized by what they do are listed here, and are **case sensitive**. Individual logs are written in _UPPER\_CASE_, while category names (which can be used in place of individual log names, see [configuring channels](../management-commands/config.md#channels)) are _Capitalized_. Each one of them is separated by categories in the lists below. To log all events, use an asterisk (`*`). All logs require the bot to have permission to view and send messages, embed links and attach files in the respective channels. Some logs require the bot to have the "View Audit Log" permission enabled at server level.
9+
Logs, categorized by what they do, are listed here and are **case sensitive**. Individual logs are written in _UPPER\_CASE_, while category names (which can be used in place of individual log names, see [configuring channels](../management-commands/config.md#channels)) are _Capitalized_. Each one of them is separated by categories in the lists below. To log all events, use an asterisk (`*`). All logs require the bot to have permission to view and send messages, embed links and attach files in the respective channels. Some logs require the bot to have the "View Audit Log" permission enabled at server level.
1010

1111
## Moderation
1212

management-commands/config.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ By default, a user is required to have the following permissions to use this com
2323
* Manage Server
2424

2525
For more information on editing permission requirements for specific users/roles, refer to
26-
the [permissions tutorial](<linkToPermissionsTutorial>)
26+
the [permissions tutorial](../start-up/permission-tutorial.md)
2727

2828
## roles edit
2929

@@ -68,7 +68,7 @@ MoonlightBot requires the following permissions to successfully execute this sub
6868
## roles self-assignable
6969

7070
This command allows you to set up a role to be self-assignable by users. This allows them to assign the role to
71-
themselves via the [`selfrole`](../role-management-commands/selfrole.md) command without needing a moderator to do it
71+
themselves via the [`/selfrole`](../role-management-commands/selfrole.md) command without needing a moderator to do it
7272
for them, and they can remove it themselves as well. It works on a vice versa basis.
7373

7474
```text
@@ -160,7 +160,7 @@ This command allows you to set up and manage groups for reaction roles. If the g
160160

161161
{% hint style="info" %}
162162
For information on how to delete a group, refer to
163-
the [`reaction-roles`](../management-commands/reaction-roles.md#delete) command and for information on how to set up
163+
the [`/reaction-roles delete`](../management-commands/reaction-roles.md#delete) command and for information on how to set up
164164
reaction roles, refer to the [`Setting up reaction roles`](../start-up/setting-up-reaction-roles.md) tutorial.
165165
{% endhint %}
166166

@@ -171,11 +171,11 @@ reaction roles, refer to the [`Setting up reaction roles`](../start-up/setting-u
171171
* `group`: The group to be configured or created
172172
* `join-only`: Prevents the user from removing their role(s)
173173
* `leave-only`: Prevents the user from assigning the role(s)
174-
* `reverse`: When the message is reacted on, it will remove the role instead of assigning it, and vice versa
174+
* `reverse`: When the message is reacted to, it will remove the role instead of assigning it, and vice versa
175175
* `max-roles`: The maximum amount of roles within the group a user can assign themselves
176176
* `dm-notification`: When a role is assigned/removed, the bot will message the user (true by default)
177177
* `freeze`: When true, the group will not function. This is a quick way to disable reaction roles without taking
178-
irreversible actions, such as deleting group/message or removing reactions from the message
178+
irreversible actions, such as deleting the group/message or removing reactions from the message
179179
* `duration`: How long the user will keep their assigned role(s)
180180

181181
### Required permissions
@@ -198,7 +198,7 @@ Note that you can make exceptions to the `mute-evasion-ban` via the
198198
```
199199

200200
* `mute-role`: The role to be used as the mute role which can be created via the
201-
[`create-muterole`](../management-commands/create-muterole.md#create-muterole) command
201+
[`/create-muterole`](../management-commands/create-muterole.md#create-muterole) command
202202
* `mute-evasion-ban`: If the bot should automatically ban anyone who sends a message and has the mute role to avoid
203203
punishment evasion
204204
* `locale`: The language to be used for the server
@@ -213,4 +213,4 @@ MoonlightBot requires the following permissions to successfully execute this sub
213213

214214
*This command does not trigger any log events.*
215215

216-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
216+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

management-commands/create-muterole.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ By default, a user is required to have the following permissions to use this com
2828
* Manage Server
2929

3030
For more information on editing permission requirements for specific users/roles, refer to
31-
the [permissions tutorial](<linkToPermissionsTutorial>)
31+
the [permissions tutorial](../start-up/permission-tutorial.md)
3232

3333
## Syntax
3434

@@ -44,4 +44,4 @@ the [permissions tutorial](<linkToPermissionsTutorial>)
4444

4545
*This command does not trigger any log events.*
4646

47-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
47+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

miscellaneous-commands/check-duration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ By default, a user is required to have the following permissions to use this com
2727

2828
*No specific permissions required*
2929

30-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](<linkToTermissionsTutorial>)
30+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
3131

3232
## Syntax
3333

@@ -39,4 +39,4 @@ For more information on editing permission requirements for specific users/roles
3939

4040
*This command does not trigger any log events.*
4141

42-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
42+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

miscellaneous-commands/premium.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
_No specific permissions required_
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](linkToTermissionsTutorial/)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## info
1818

@@ -30,10 +30,10 @@ MoonlightBot requires the following permissions to successfully execute this sub
3030

3131
_No specific permissions required_
3232

33-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](linkToTermissionsTutorial/)
33+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
3434

3535
## Logs
3636

3737
_This command does not trigger any log events._
3838

39-
For more information on setting up those logs, refer to the [log setup tutorial](linkToLogTutorial/)
39+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

miscellaneous-commands/userconfig.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
_No specific permissions required_
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](linkToPermissionsTutorial/)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## settings
1818

@@ -36,4 +36,4 @@ _No specific permissions required_
3636

3737
_This command does not trigger any log events._
3838

39-
For more information on setting up those logs, refer to the [log setup tutorial](linkToLogTutorial/)
39+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/ban.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
* Ban Members
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](<linkToPermissionsTutorial>)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## Syntax
1818

@@ -35,4 +35,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
3535

3636
* `BAN`: This log is triggered when a user is successfully banned. It will log the user, the responsible moderator and the reason for the ban. If an infraction is created, it will also include the infraction ID
3737

38-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
38+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/clean.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# clean
22

3-
This command deletes a large amount of messages from a channel, optionally limited by specifying some deletion criteria. Criteria are options that distinguish messages such as those that contain a specific phrase. Using multiple criteria will narrow the selection to only messages that fit all of them. Up to 100 messages can be deleted in a single execution of the command, and only those sent within the last 14 days.
3+
This command deletes a large amount of messages from a channel, optionally limited by specifying some deletion criteria. Criteria are options that distinguish messages such as those that contain a specific phrase. Using multiple criteria will narrow the selection to only messages that fit all of them. Due to limitations imposed by Discord, only messages sent within the last 14 days can be deleted.
44

55
## Required permissions
66

@@ -15,7 +15,7 @@ By default, a user is required to have the following permissions to use this com
1515

1616
* Manage Messages
1717

18-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](/start-up/permission-tutorial.md)
18+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1919

2020
## Syntax
2121

@@ -26,12 +26,12 @@ For more information on editing permission requirements for specific users/roles
2626
### Options
2727

2828
* `amount`: The amount of messages you want to clean (The default/maximum amount is 100)
29-
* `user`: The user you want to do delete the messages of
29+
* `user`: Delete messages sent by a specified user
3030
* `starts-with`: Delete messages that start with this value
3131
* `ends-with`: Delete messages that end with this value
3232
* `contains`: Delete messages that contain this value
33-
* `bots`: Whether or not to delete messages sent by bots. If this option is left blank, the bot will delete these messages, but if left as true, the bot will only delete messages by bots, otherwise it will only delete messages not sent by bots
34-
* `system`: Whether or not to delete system messages. System messages are messages sent by Discord, such as join or pin messages
33+
* `bots`: Whether or not to delete messages sent by bots. If this option is left blank, the bot will not differentiate between messages sent by users and bots. If set to false, the bot will not delete bot messages, but if set to true, the bot will only delete bot messages
34+
* `system`: Whether or not to delete system messages. System messages are messages sent by Discord, such as join or pin messages. This uses the same syntax as the `bots` option
3535
* `preserve-pins`: If true, pinned messages will not be deleted
3636
* `no-trace`: If true, the confirmation message will only be visible to you
3737

@@ -42,7 +42,7 @@ For more information on editing permission requirements for specific users/roles
4242
![An example of logs sent by the bot after a clean command execution](/.gitbook/assets/CleanLogs.png "Clean Logs")
4343

4444
{% hint style="info" %}
45-
To open an HTML file, download it and open the file explorer. Double-click the file, and your computer will open a new tab in your browser to display a visualization of the messages deleted
45+
Rather than rendering them like other downloadable files, Discord displays the raw content of HTML files. To download the HTML file, click the download button at the bottom-right of the file display. Double-click the file, and your computer will open a new tab in your browser to display a visualization of the messages deleted.
4646
{% endhint %}
4747

48-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
48+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/infractions.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
* Moderate Members
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](/start-up/permission-tutorial.md)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## summary
1818

@@ -48,7 +48,7 @@ MoonlightBot requires the following permissions to successfully execute this sub
4848

4949
## reason
5050

51-
Changes the reason of the infraction. If the `reason` option is left blank, it will simply display the current one
51+
Changes the reason of the infraction. If the `reason` option is left blank, it will simply display the current one. You can alternatively use `%%%` to automatically copy the old content so you don't have to type it again
5252

5353
```text
5454
/infractions reason <id> [reason]
@@ -74,8 +74,8 @@ Shows a list of infractions that fit all the specified criteria, such as the mod
7474
* `target`: The user you want to see the infractions of
7575
* `moderator`: The infractions executed by a specific moderator
7676
* `type`: The type of the infractions you want to view
77-
* `before`: View infractions executed before this date
78-
* `after`: View infractions after this date
77+
* `before`: View infractions executed before this duration
78+
* `after`: View infractions after this duration
7979

8080
### Required permissions
8181

@@ -87,6 +87,10 @@ MoonlightBot requires the following permissions to successfully execute this sub
8787

8888
Deletes an infraction
8989

90+
{% hint style="danger" %}
91+
This cannot be undone! Be absolutely sure that you want to delete the infraction before running this command.
92+
{% endhint %}
93+
9094
```text
9195
/infractions delete <id> [reason]
9296
```
@@ -105,4 +109,4 @@ MoonlightBot requires the following permissions to successfully execute this sub
105109
* `REASON_UPDATE`: Shows the user the infraction affects, the moderator who executed it, and the updated reason
106110
* `INFRACTION_DELETE`: Same as above, with the reason being why the infraction was deleted
107111

108-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
112+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/kick.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
* Kick Members
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](<linkToPermissionsTutorial>)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## Syntax
1818

@@ -35,4 +35,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
3535

3636
* `KICK`: This log is triggered when a user is kicked from a server. It will log the user, the responsible moderator and the reason for the kick. If an infraction is created, it will also include the infraction ID
3737

38-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
38+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/mute.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ By default, a user is required to have the following permissions to use this com
1616

1717
* Moderate Members
1818

19-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](linkToPermissionsTutorial/)
19+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
2020

2121
## Syntax
2222

@@ -40,4 +40,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
4040

4141
* `MUTE`: This log is triggered when a user is muted. It will log the user, the responsible moderator and the reason for the muting. If an infraction is created, it will also include the infraction ID
4242

43-
For more information on setting up those logs, refer to the [log setup tutorial](linkToLogTutorial/)
43+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/softban.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
* Ban Members
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](<linkToPermissionsTutorial>)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## Syntax
1818

@@ -35,4 +35,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
3535

3636
* `SOFTBAN`: This log is triggered when a user is softbanned. It will log the user, the responsible moderator and the reason for the softban. If an infraction is created, it will also include the infraction ID
3737

38-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
38+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/tempban.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By default, a user is required to have the following permissions to use this com
1212

1313
* Ban Members
1414

15-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](<linkToPermissionsTutorial>)
15+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
1616

1717
## Syntax
1818

@@ -37,4 +37,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
3737
* `TEMPBAN_EXTEND`: This log is triggered when a tempban is successfully extended. It will log the user, the responsible moderator and the reason for the extended ban.
3838
* `BAN`: This log is triggered when a user is successfully banned. It will log the user, the responsible moderator and the reason for the ban. If an infraction is created, it will also include the infraction ID
3939

40-
For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
40+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

moderation-commands/tempmute.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ By default, a user is required to have the following permissions to use this com
1616

1717
* Moderate Members
1818

19-
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](linkToPermissionsTutorial/)
19+
For more information on editing permission requirements for specific users/roles, refer to the [permissions tutorial](../start-up/permission-tutorial.md)
2020

2121
## Syntax
2222

@@ -42,4 +42,4 @@ The user will not be notified if both `notify` and `no-infraction` are set to Tr
4242
* `TEMPMUTE_EXTEND`: This log is triggered when a tempmute is successfully extended. It will log the user, the responsible moderator and the reason for the extended mute.
4343
* `MUTE`: This log is triggered when a user is muted. It will log the user, the responsible moderator and the reason for the muting. If an infraction is created, it will also include the infraction ID
4444

45-
For more information on setting up those logs, refer to the [log setup tutorial](linkToLogTutorial/)
45+
For more information on setting up those logs, refer to the [log setup tutorial](../README.md#logging)

0 commit comments

Comments
 (0)