feat(docs): add documentation and split contents of commands to different files

docs/COMMANDS.md

@@ -1,92 +1,11 @@
 # Commands for the bot
 
-## Staff
+These are all the commands that you can use for the bot. Some of these are for staff only, but everyone can use the 
+general commands
 
-### Mentors
-
-- `/vegcurious <user>`/`?veg <user>` - Gives/removes the Veg Curious role from the user, only Mentor Coordinator can
-  give the veg curious role to vegans.
-- `/convinced <user>`/`?conv <user>` - Gives/removes the Convinced role from the user.
-
-### Moderation
-- `/ban <user> <reason>`/`?ban <user> <reason>` - Permanently bans that user.
-- `/unban <user>`/`?unban <user>` - Unbans that user.
-- `/rename <user> <optional: nickname>`/`?ru <user> <optional: nickname>` - Renames that user to the specified nickname,
-if nickname is left blank it will reset the nickname to their original username.
-- `/trusted <user>`/`?t <user>` - Gives/removes the Trusted role from the user.
-
-### Sus
-This command stores notes on users that could be information on the user
-or anything that is not serious enough for a warning.
-
-#### Classic Commands
-- `?sus <user> <note>` Add a note to the user
-
-#### Application Commands
-
-- `/sus add <user> <note>`
-- `/sus view <user>`
-- `/sus remove <id>`
-- `/sus purge <user>`
-
-## Coordinator Only
-
-- `/access <permission> <channel> <user/role>` - Gives/removes specific access to a user/role from a channel in 
-ModMail/Private/Restricted categories.
-- `/anonymous <message> <optional: channel>`/`?anon <channel> <message>` - Sends a message via the bot (optionally if
-channel has been defined, to that channel).
-- `/clear <messages>`/`?clear <messages>` - Bulk deletes 1-100 messages.
-- `/moveall <channel>`/`?mvall <channel>` - Moves everyone in the current voice channel to the specified voice channel.
-- `/plus <user>`/`?plus <user>` - Gives/removes the Plus role from the user. This role is for members that are 18+.
-
-### Private Channels
-
-- `/private create <user>` - Creates a private channel for that user for the specific coordinator team you are on.
-- `/private delete <optional: user>` - Deletes the private channel, either the channel you are currently in or if
-specified the optional channel, the channel you declared. You can only delete your specific coordinator team's private
-channels.
-
-### Diversity Team
-
-- `/diversity <user>`/`?div <user>` - Gives/removes the Diversity Team role from the user.
-- `/diversity toggleopen` - toggles the diversity chat open or closed.
-
-### Events Team
-
-- `/stagehost <user>`/`?stagehost <user>` - Gives/removes the Stage Host role from the user.
-- `/bookclub <user>`/`?bookclub <user>` - Gives/removes the Book Club role from the user.
-- `/debatehost <user>`/`?debatehost <user>` - Gives/removes the Debate Host role from the user.
-- `/gamenight <user>`/`?gamenight <user>` - Gives/removes the Game Night Host role from the user.
-- `/guest <user>`/`?guest <user>` - Gives/removes the Guest role from the user.
-
-### Mentor Team
-
-- `/mentor <user>`/`?mentor <user>` - Gives/removes the Mentor role from the user.
-
-### Verification Team
-
-- `/vegan <user>`/`?v <user>` - Gives/removes the Vegan role from the user.
-- `/activist <user>`/`?a <user>` - Gives/removes the Activist role from the user.
-- `/verifier <user>`/`?verifier <user>` - Gives/removes the Verifier role from the user.
-- `/trialverifier <user>`/`?trialverifier <user>` - Gives/removes the Trial Verifier role from the user.
-
-### Mod Team
-
-- `/mod <user>`/`?mod <user>` - Gives/removes the Mod role from the user.
-- `/restrictedaccess <user>`/`?ra <user>` - Gives/removes the Restricted Access role from the user.
-
-## Utilities
-
-- `/ping` - Checks if the bot is alive and the ping of the bot.
-- `/apply`/`?apply` - Gives you the link to where you can apply to be a Moderator or Verifier.
-- `/count`/`?count` - Tells you how many vegans and non-vegans there are on the server.
-
-## Fun Commands
-
-- `/1984`
-- `/happy`
-- `/hug`
-- `/kill`
-- `/poke`
-- `/sad`
-- `/shrug`
+## Contents
+- [General](commands/GENERAL.md)
+- [Moderator](commands/MOD.md)
+- [Verifier](commands/VERIFIER.md)
+- [Mentor](commands/MENTOR.md)
+- [Coordinator](commands/COORDINATOR.md)

docs/commands/COORDINATOR.md

@@ -0,0 +1,47 @@
+# Coordinator Commands
+
+## General Coordinator Commands
+
+- `/access <permission> <channel> <user/role>` - Gives/removes specific access to a user/role from a channel in
+  ModMail/Private/Restricted categories.
+- `/anonymous <message> <optional: channel>`/`?anon <channel> <message>` - Sends a message via the bot (optionally if
+  channel has been defined, to that channel).
+- `/clear <messages>`/`?clear <messages>` - Bulk deletes 1-100 messages.
+- `/moveall <channel>`/`?mvall <channel>` - Moves everyone in the current voice channel to the specified voice channel.
+- `/plus <user>`/`?plus <user>` - Gives/removes the Plus role from the user. This role is for members that are 18+.
+
+## Private Channels
+
+- `/private create <user>` - Creates a private channel for that user for the specific coordinator team you are on.
+- `/private delete <optional: user>` - Deletes the private channel, either the channel you are currently in or if
+  specified the optional channel, the channel you declared. You can only delete your specific coordinator team's private
+  channels.
+
+## Diversity Team
+
+- `/diversity <user>`/`?div <user>` - Gives/removes the Diversity Team role from the user.
+- `/diversity toggleopen` - toggles the diversity chat open or closed.
+
+## Events Team
+
+- `/stagehost <user>`/`?stagehost <user>` - Gives/removes the Stage Host role from the user.
+- `/bookclub <user>`/`?bookclub <user>` - Gives/removes the Book Club role from the user.
+- `/debatehost <user>`/`?debatehost <user>` - Gives/removes the Debate Host role from the user.
+- `/gamenight <user>`/`?gamenight <user>` - Gives/removes the Game Night Host role from the user.
+- `/guest <user>`/`?guest <user>` - Gives/removes the Guest role from the user.
+
+## Mentor Team
+
+- `/mentor <user>`/`?mentor <user>` - Gives/removes the Mentor role from the user.
+
+## Verification Team
+
+- `/vegan <user>`/`?v <user>` - Gives/removes the Vegan role from the user.
+- `/activist <user>`/`?a <user>` - Gives/removes the Activist role from the user.
+- `/verifier <user>`/`?verifier <user>` - Gives/removes the Verifier role from the user.
+- `/trialverifier <user>`/`?trialverifier <user>` - Gives/removes the Trial Verifier role from the user.
+
+## Mod Team
+
+- `/mod <user>`/`?mod <user>` - Gives/removes the Mod role from the user.
+- `/restrictedaccess <user>`/`?ra <user>` - Gives/removes the Restricted Access role from the user.

docs/commands/GENERAL.md

@@ -0,0 +1,28 @@
+# General commands
+
+## Utilities
+
+- `/ping` - Checks if the bot is alive and the ping of the bot.
+- `/apply`/`?apply` - Gives you the link to where you can apply to be a Moderator or Verifier.
+- `/count`/`?count` - Tells you how many vegans and non-vegans there are on the server.
+
+## Economy
+
+- `/daily`/`?daily` - Gives you a daily reward of ARAs
+- `/pay <user> <amount> <reason>`/`?pay <user> <amount> <reason>` - Give a user an amount of ARAs
+- `/balance`/`?balance` - Checks how many ARAs you have
+
+## XP
+
+- `/rank <optional: user>`/`?rank <optional: user>` - Shows your rank based on the amount of XP you have. If you provide
+a user, it will display that user's rank instead.
+
+## Fun Commands
+
+- `/1984`
+- `/happy`
+- `/hug`
+- `/kill`
+- `/poke`
+- `/sad`
+- `/shrug`

docs/commands/MENTOR.md

@@ -0,0 +1,4 @@
+# Mentor Commands
+
+- `/vegcurious <user>`/`?veg <user>` - Gives/removes the Veg Curious role from the user (only usable on non-vegans).
+- `/convinced <user>`/`?conv <user>` - Gives/removes the Convinced role from the user.

docs/commands/MOD.md

@@ -0,0 +1,50 @@
+# Moderation Commands
+
+## General Moderation
+
+- `/rename <user> <optional: nickname>`/`?ru <user> <optional: nickname>` - Renames that user to the specified nickname,
+  if nickname is left blank it will reset the nickname to their original username.
+- `/slowmode <duration>`/`?slowmode <duration>` - changes the slowmode for a chat. Duration uses a time which can be set by providing a number 
+followed by s/d/m/y or just writing `off`. These can be combined. 
+For example to set the slowmode for 1 minute and 30 seconds, you would write: `1m 30s`.
+- `/softmute <user>`/`?sm/softmute <user>` - Prevents the user from reacting to messages.
+- `/vcmute <user>`/`?vcmute <user>` - Adds a persistent VC mute if the user has left the VC or leaves the server to 
+circumvent VC mutes.
+- `?warn <user> <reason>` - Gives a warning to the user.
+
+## Roles
+
+These are roles you can give/take away from users.
+
+- `/trusted <user>`/`?t <user>` - Gives/removes the Trusted role from the user.
+- `/vegcurious <user>`/`?veg <user>` - Gives/removes the Veg Curious role from the user (only usable on non-vegans).
+- `/convinced <user>`/`?conv <user>` - Gives/removes the Convinced role from the user.
+
+## Sus
+
+This command stores notes on users that could be information on the user
+or anything that is not serious enough for a warning.
+
+- `/sus add <user> <note>`/`?sus <user> <note>` - Add a note to the user
+- `/sus view <user>` - View notes made on the user
+- `/sus remove <id>` - Remove a specific note from the sus note id, which you can get from using `/sus view`
+- `/sus purge <user>` - Remove all sus notes from the user
+
+## Restrictions
+
+These are used for users that have broken rules severe enough that takes away their access to the server.
+
+- `/restrict <user> <reason>`/`?r/restrict <user> <reason>` - Restricts the user to the restricted section
+- `/unrestrict <user>`/`?ur <user>` - Unrestricts the user
+- `/restrictlogs <optional: user>` - Shows the logs of when the user has been restricted. The need to provide the user 
+is optional depending on if the command is run in the ModMail category.
+- `/restricttools channel delete <optional: user>` - Deletes the vegan restricted channel for the user. Providing a user
+is only optional if the command is run in the channel that is to be deleted.
+
+## Bans
+
+- `/tempban <user> <duration> <reason>`/`?tempban <user> <duration <reason>` - Bans the user for a specific amount of
+time. Duration uses a time which can be set by providing a number followed by s/d/m/y. These can be combined.
+For example to ban someone for 1 week and 3 days, you would write: `1w 3d`.
+- `/ban <user> <reason>`/`?ban <user> <reason>` - Permanently bans that user.
+- `/unban <user>`/`?unban <user>` - Unbans that user.

docs/commands/VERIFIER.md

@@ -0,0 +1,30 @@
+# Verifier Commands
+
+## Verification
+
+- `/verify <user> <roles>`/`?ver <user> <roles>` - This is a manual verification to give roles to a user. This should 
+not be used if you are verifying the user in the voice channel. Roles available (you can write multiple in one command
+such as `v a t`):
+  - `v` - Vegan
+  - `a` - Activist
+  - `t` - Trusted
+  - `x` - ARA Vegan (went vegan because of ARA)
+  - `nv` - Not Vegan
+  - `conv` - Convinced
+  - `veg` - Veg Curious
+
+- `/verifytimeoutremove <user>` - Removes a verification timeout if the user has been timed out as a verifier was not 
+available. This cannot be used for users that have been verified.
+
+## Roles
+
+These are roles you can give/take away from users.
+
+- `/trusted <user>`/`?t <user>` - Gives/removes the Trusted role from the user.
+- `/vegcurious <user>`/`?veg <user>` - Gives/removes the Veg Curious role from the user (only usable on non-vegans).
+- `/convinced <user>`/`?conv <user>` - Gives/removes the Convinced role from the user.
+
+### Roles you can only give
+
+- `/vegan <user>`/`?v <user>` - Give the vegan role
+- `/activist <user>`/`?a <user>` - Gives the activist role