Mod Commands T-Z Docs Update (#37)

Updates Mod Commands T-Z in the Docs

---------

Co-authored-by: MoonlightCapital <[email protected]>

moderation-commands/tempban.md

@@ -1,6 +1,6 @@
 # tempban
 
-<TODO: describe>
+The `tempban` command temporarily bans a user from the current server.
 
 ## Required permissions
 
@@ -22,15 +22,19 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `duration`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `notify`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
+* `user`: The user that you want to ban
+* `duration`: The duration you want to ban them for. For more information on the duration format, refer to the [arguments page](../start-up/arguments.md#durations)
+* `reason`: The reason you want to ban them. This is an optional parameter, which can be used for record-keeping
+* `notify`: Whether the target user will be notified by Direct Message (True/False). This is optional and contains the server name and reason
+* `no-infraction`: Whether the ban counts as an infraction or not (True/False).
+
+{% hint style="warning" %}
+The user will not be notified if both `notify` and `no-infraction` are set to True
+{% endhint %}
 
 ## Logs
 
-* `TEMPBAN_EXTEND`: <TODO: describe>
-* `BAN`: <TODO: describe>
+* `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.
+* `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
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)

moderation-commands/tempmute.md

@@ -1,6 +1,10 @@
 # tempmute
 
-<TODO: describe>
+The `tempmute` command temporarily mutes a user from the current server. This is intended to revoke the user's permissions to talk in the server while still being able to read messages, or otherwise restrict accordingly to the server's preferences.
+
+{% hint style="info" %}
+A server administrator needs to configure a mute role in order to enable this command. This can be done quickly with the [`/create-muterole`](../management-commands/create-muterole.md) command.
+{% endhint %}
 
 ## Required permissions
 
@@ -22,16 +26,20 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `duration`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `notify`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
-* `remove-roles`: <TODO: describe>
+* `user`: The user that you want to mute
+* `duration`: The duration of the tempmute. For more information on the duration format, refer to the [arguments page](../start-up/arguments.md#durations)
+* `reason`: The reason you want to mute them. This is an optional parameter, which can be used for record-keeping
+* `notify`: Whether the target user will be notified by Direct Message (True/False). This is optional and contains the server name and reason
+* `no-infraction`: Whether the tempmute counts as an infraction or not (True/False).
+* `remove-roles`: Whether to temporarily remove the users roles or not (True/False)
+
+{% hint style="warning" %}
+The user will not be notified if both `notify` and `no-infraction` are set to True
+{% endhint %}
 
 ## Logs
 
-* `TEMPMUTE_EXTEND`: <TODO: describe>
-* `MUTE`: <TODO: describe>
+* `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.
+* `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
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)

moderation-commands/timeout.md

@@ -1,6 +1,6 @@
 # timeout
 
-<TODO: describe>
+The `timeout` command temporarily times out a user from the current server.
 
 ## Required permissions
 
@@ -22,15 +22,19 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `duration`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `notify`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
+* `user`: The user that you want to ban
+* `duration`: The duration you want to time them out for. For more information on the duration format, refer to the [arguments page](../start-up/arguments.md#durations)
+* `reason`: The reason you want to time them out. This is an optional parameter, which can be used for record-keeping
+* `notify`: Whether the target user will be notified by Direct Message (True/False). This is optional and contains the server name and reason
+* `no-infraction`: Whether the ban counts as an infraction or not (True/False).
+
+{% hint style="warning" %}
+The user will not be notified if both `notify` and `no-infraction` are set to True
+{% endhint %}
 
 ## Logs
 
-* `TIMEOUT_REMOVE`: <TODO: describe>
-* `TIMEOUT`: <TODO: describe>
+* `TIMEOUT_REMOVE`: This log is triggered when a user is removed from timeout. It will log the user, the responsible moderator and the reason for the timeout removal.
+* `TIMEOUT`: This log is triggered when a user is timed out. It will log the user, the responsible moderator and the reason for the timeout. If an infraction is created, it will also include the infraction ID
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)

moderation-commands/unban.md

@@ -1,6 +1,6 @@
 # unban
 
-<TODO: describe>
+The `unban` command unbans a user from the current server.
 
 ## Required permissions
 
@@ -22,12 +22,12 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
+* `user`: The user that you want to unban
+* `reason`: The reason you want to unban them. This is an optional parameter, which can be used for record-keeping
+* `no-infraction`: Whether the unban counts as an infraction or not (True/False).
 
 ## Logs
 
-* `UNBAN`: <TODO: describe>
+* `UNBAN`: This log is triggered when a user is successfully unbanned. It will log the user, the responsible moderator and the reason for the unban. If an infraction is created, it will also include the infraction ID
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)

moderation-commands/unmute.md

@@ -1,6 +1,6 @@
 # unmute
 
-<TODO: describe>
+The `Unmute` command can be used to Unmute a user that is currently muted - this must have been a mute enacted via MoonlightBot
 
 ## Required permissions
 
@@ -22,13 +22,17 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `notify`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
+* `user`: The user that you want to unmute
+* `reason`: The reason you want to unmute them. This is an optional parameter, which can be used for record-keeping
+* `notify`: Whether the target user will be notified by Direct Message (True/False)
+* `no-infraction`: Whether the unmute counts as an infraction or not (True/False).
+
+{% hint style="warning" %}
+The user will not be notified if both `notify` and `no-infraction` are set to True
+{% endhint %}
 
 ## Logs
 
-* `UNMUTE`: <TODO: describe>
+* `UNMUTE`: This log is triggered when a user is successfully unmuted. It will log the user, the responsible moderator and the reason for the unmute. If an infraction is created, it will also include the infraction ID
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)

moderation-commands/warn.md

@@ -1,6 +1,6 @@
 # warn
 
-<TODO: describe>
+The `warn` command issues a warning to a user in the current server.
 
 ## Required permissions
 
@@ -22,13 +22,17 @@ For more information on editing permission requirements for specific users/roles
 
 ### Options
 
-* `user`: <TODO: describe>
-* `reason`: <TODO: describe>
-* `notify`: <TODO: describe>
-* `no-infraction`: <TODO: describe>
+* `user`: The user that you want to Warn - this is mandatory
+* `reason`: The reason you want to warn them. This is an optional parameter, which can be used for record-keeping
+* `notify`: Whether the target user will be notified by Direct Message (True/False)
+* `no-infraction`: Whether the warning counts as an infraction or not (True/False). This is optional and contains the server name and reason
+
+{% hint style="warning" %}
+The user will not be notified if both `notify` and `no-infraction` are set to True
+{% endhint %}
 
 ## Logs
 
-* `WARNING`: <TODO: describe>
+* `WARN`: This log is triggered when a user is successfully warned. It will log the user, the responsible moderator and the reason for the warning. If an infraction is created, it will also include the infraction ID
 
-For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)
+For more information on setting up those logs, refer to the [log setup tutorial](<linkToLogTutorial>)