Skip to content

Commit

Permalink
feat(docs): little changes + added jail setup
Browse files Browse the repository at this point in the history
  • Loading branch information
l6xur committed Aug 18, 2024
1 parent 0ac2df6 commit e8b4db4
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 3 deletions.
Binary file added images/jail/jail.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/jail/jail1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/jail/jail2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/twitch/twitch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions linkable/twitch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ For example, to add twitch streams from the user "kaicenat" to the `#streams` ch
<Frame caption="Setting up twitch with greed.">
<img src="/images/twitch/twitch.gif" />
</Frame>
</Step>

<Step title="Example preview">
Here is an example on how greed previews twitch streams
<Frame caption= "Example of greed notifying">
<img src="/images/twitch/twitch.png" />
</Frame>
</Step>
</Steps>
3 changes: 2 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@
"pages": [
"server-config/anti-raid",
"server-config/anti-nuke",
"server-config/logging"
"server-config/logging",
"server-config/jail-setup"
],
"icon": "gear"
},
Expand Down
2 changes: 1 addition & 1 deletion server-config/anti-nuke.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Anti-nuke"
title: "Anti nuke"
description: "Anti-raid in Discord is like a protective barrier that keeps your server safe from trolls and spammers trying to crash your online party."
---

Expand Down
2 changes: 1 addition & 1 deletion server-config/anti-raid.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Anti-raid"
title: "Anti raid"
description: "Anti-raid in Discord is like a protective barrier that keeps your server safe from trolls and spammers trying to crash your online party."
---

Expand Down
46 changes: 46 additions & 0 deletions server-config/jail-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,50 @@ description: "Setting up jail in your discord server."
icon: ""
---

<CardGroup cols={2}>
<Card title="Jail setup" icon="handcuffs" href="#setting-up-jail">
Automatically create a channel named 'jail.' This channel will serve as a restricted area for users who violate server rules.
</Card>
<Card title="How to jail a user" icon="question" href="#jailing-users">
Learn how to enforce server rules and restrict users by setting up a jail system. Automatically create a channel where rule violators will be confined.
</Card>
</CardGroup>


# Setting up jail

<Steps>
<Step title="Head over to your Discord Server">
Click on the Discord Server where you want to set up the jail system using your bot, Greed.
</Step>
<Step title="Configuring Jail">
- Run the command `,setupjail` in any channel.
- This command will automatically create a channel called `jail`.
- You can customize the name of the jail channel if needed.

<Frame caption="Creating jail channel & role.">
<img src="/images/jail/jail.gif" />
</Frame>
</Step>
</Steps>

# Jailing users

<Steps>
<Step title="Configuring Jail">
- Run the command `,jail <user>` for example `,jail @x6ur` in any channel.
- This command will automatically mutes the user in every channel besides `jail` for the user.

<Frame caption="Example of jailing a user.">
<img src="/images/jail/jail1.gif" />
</Frame>
</Step>
<Step title="Unjaling a user">
- Run the command `,ujail <user>` for example `,ujail @x6ur` in any channel.
- This command will automatically unjail the mentioned user.

<Frame caption="Example of unjailing a user.">
<img src="/images/jail/jail2.gif" />
</Frame>
</Step>
</Steps>

0 comments on commit e8b4db4

Please sign in to comment.