beemobot / docs.beemo.gg

Docs for Beemo the Discord bot (https://beemo.gg)
https://docs.beemo.gg
MIT License
10 stars 12 forks source link

Docs/moderation: add mod-command list #7

Closed ghost closed 3 years ago

ghost commented 3 years ago

Changes

This PR adds a commands table for all of the basic moderation commands to the moderation category header, I was unsure if this would be best suited somewhere else but I thought since it's titled "moderation" it could be a good fit, and nesting a category called "moderation" under "moderation" would look weird. Open to moving it to a better location if you have any ideas of a sub category.

This change also uses the table format from #6 as it was indicated this would be preferred (I agree, it looks way better)

ghost commented 3 years ago

Similar format but not quite the same. Your column tab is actually to be pasted under the command column. and the example column would contain sample usage (i.e instead of ID, u would use 12345).

Makes sense, will adjust

ghost commented 3 years ago

Here are some general improvements with regards to readability / clarity / consistency. Let me know what ya think.

Changes merged, would you prefer to keep the current example layout or use real examples? Unsure which one is prefered after this review.

shoaibsajid1 commented 3 years ago

Here are some general improvements with regards to readability / clarity / consistency. Let me know what ya think.

Changes merged, would you prefer to keep the current example layout or use real examples? Unsure which one is prefered after this review.

Real examples would be better and more inline with the other 3 tables. I think Ayu just recommended changes based on your PR. Whereas you were going to make changes after my comment

ghost commented 3 years ago

Here are some general improvements with regards to readability / clarity / consistency. Let me know what ya think.

Changes merged, would you prefer to keep the current example layout or use real examples? Unsure which one is prefered after this review.

Real examples would be better and more inline with the other 3 tables. I think Ayu just recommended changes based on your PR. Whereas you were going to make changes after my comment

Will make these adjustments now, I think it can be kind of confusing as what arguments are optional aren't listed with the examples - changes will be made though

ghost commented 3 years ago

So something along these lines?

Command Example Usage
Archive /archive 515067662028636170 Creates a message archive, which expires in 12 hours later, for the user specified. Archives cannot be generated for moderators or admins to ensure messages in private channels stay protected.
Avatar /avatar 515067662028636170 Gets the avatar of the specified user.
Ban /ban 515067662028636170 7d Spam Bans the user, deleting their past 7 days of messages and notifying them through DMs. This incident is also logged. Not specifying a duration sets the ban to permanent.
Cleankick /cleankick 515067662028636170 Spam Kicks the user and deletes their past 7 days of messages, notifying them through DMs and logging the incident.
Duration /duration 14 4d Edits the duration of an existing moderation case. This will also edit the DM for the user who received the action to reflect the change. You may only edit your own cases unless you are a moderation manager
Kick /kick 515067662028636170 Spam Kicks the user, notifying them through DMs and logging the incident.
Modlogs /modlogs 515067662028636170 Shows all moderation logs for a user, including a link to each cases' action log and message archive.
Modnote /modnote 515067662028636170 Spam Adds a mod note onto the user's logs; This note is only visible to moderators, and does not DM the user or show when the user types /mylogs.
Modstats /modstats 515067662028636170 before:2021/01/01 after:2020/01/01 Gets statistics of the specified moderator. You can optionally specify a before and/or after date to get stats for specific time periods. You must be a moderation manager or admin to use this command.
Mute /mute 515067662028636170 3h Spam Mutes the user, notifying them through DMs when the mute begins and ends and logging the incident. Not specifying a duration sets the mute to permanent.
Presetreasons /presetreasons spamming Lists all available preset reason variables for the server. If a preset variable is specified, this command will list the correlated preset reason.
Purge /purge 400 Mass-deletes the specified number of messages in the channel invoked. This command has a limit of 1000 messages, and may take a few seconds. You must be a moderation manager or admin to use this command.
Reason /reason 14 Advertising Edits the reason of an existing moderation case. This will also edit the DM for the user who received the action to reflect the change. You may only edit your own cases unless you are a moderation manager or admin.
Revoke /revoke 14 Appealed Revokes the specified moderation case. This will prevent the case from showing on /modlogs and will edit the DM for the user who received the action to reflect that the action is revoked. You may only revoke your own cases unless you are a moderation manager or admin.
Revokeall /revokeall 515067662028636170 Appealed Revokes all cases tied to a user, preventing them from showing up on their moderation logs. You must be a moderation manager or admin to use this command.
Saveban /saveban 515067662028636170 2d Advertising The same as /ban, except the user’s messages are not deleted.
Unban /unban 515067662028636170 Reformed Unbans the user, attempting to DM them and logging the incident.
Unmute /unmute 515067662028636170 Reformed Unmutes the user, notifying them through DMs and logging the incident.
Userinfo /userinfo 515067662028636170 Gets information regarding a user in the server, such as account age, join date, join position, and roles.
Warn /warn 515067662028636170 Spam Warns the user, notifying them through DMs and logging the incident.
shoaibsajid1 commented 3 years ago

The command column is pointless.

Example shouldn't have replaced the initial column. It should have replaced the command

So like

Command ban user

Example /ban @Ayu

Usage This bans user

Example enhances and makes it easy to understand the command and it's arguments

The example includes prefix whereas the command column doesn't

ghost commented 3 years ago

Yeah, my apology it looks like I confused myself when moving it over, I'll readjust it later today - smooth brain moment

ghost commented 3 years ago

Corrected 👍