Skip to content

Commit

Permalink
added into and custom-commands add page
Browse files Browse the repository at this point in the history
  • Loading branch information
hello391 committed Sep 8, 2024
1 parent d159042 commit c36aa58
Show file tree
Hide file tree
Showing 13 changed files with 132 additions and 6 deletions.
15 changes: 15 additions & 0 deletions docs/custom-commands/add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Add Command

## Usage
`/custom commands add` `<name>` `<description>` `<response>` Creates a custom slash command in your server
:::info[`Manage Guild`]
:::

## Details
+ `<name>` Must be less than or equal to 32 characters and can only be one word, you can not use numbers. To use more than one word split it with a `-` or an `_`. So `/help me` would become `/help-me` or `/help_me`. Aslo you can't use uppercase letter they will be auto changed to lowercase. The name can not be the same as one of the Helpr's commands or be the same as a custom command you have already made. These are all limitations imposed by Discord so I can not change them
+ `<description>` Must be less than or equal to 50 characters. You can use things like emojis or numbers in this and can use as many words as you want.
+ `<response>` Must be less than or equal to 2000 characters. You can use anything that you could send in a normal message, please not custom emojis might not work if Helpr is not in the server or if you do not use the emoji's id (`<name:id>`)

## Limits
+ You can only have 25 custom commands per server. (To request an increase in this amount please create a ticket in the support server [here](https://helpr.gg/server). Please tell us why you need more commands, and we will aprove/deny based on your needs.)
+ You can only create 200 commands per day, so if you create and delete a bunch of commands over and over then it will stop working after 200 creations. This is a limit imposed by Discord so I can not change it.
Empty file added docs/custom-commands/list.md
Empty file.
Empty file added docs/custom-commands/remove.md
Empty file.
2 changes: 2 additions & 0 deletions docs/delete-my-data/custom-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Deleting Custom Commands Data
If you want to delete your guild's custom command data all you have to do is run [`/custom commands remove`](../custom-commands/remove) untill all the custom commands are gone.
16 changes: 16 additions & 0 deletions docs/delete-my-data/guild.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Deleting Guild Data
If you want to delete your guild's data please join the support server [here](https://helpr.gg) and create a ticket.

Please send your guild ID, and specify that you want to delete your guild's data in the channel when you create the ticket

:::warning

Only the server owner can request to delete your server's data

:::

:::danger

This action is not reversible and will delete all of your data for all categories, so if you just want to delete a specific catagory see the specific page for that category

:::
16 changes: 16 additions & 0 deletions docs/delete-my-data/levels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Deleting Levels Data
If you want to delete your guild's levels data please join the support server [here](https://helpr.gg) and create a ticket.

Please send your guild ID, and specify that you want to delete your guild's levels data in the channel when you create the ticket

:::warning

Only the server owner can request to delete your server's level data

:::

:::danger

This action is not reversible and will delete all of your data for of the leveling system, including users's xp and level and all custom role rewards. If you just want to change the configs see [Levels Commands](../levels)

:::
10 changes: 10 additions & 0 deletions docs/delete-my-data/user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Deleting User Data
If you want to delete your user data please join the support server [here](https://helpr.gg) and create a ticket.

Please specify what data you want to delete, you can request a list of things to delete if you are not sure or you can delete eveything

:::danger

This action is not reversible and will delete all of your user data in all the guilds you are in for whatever catgory you choose to delete

:::
27 changes: 27 additions & 0 deletions docs/getting-started/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Intro

## Usage
You will see command usage details for each command in a `Usage` Headding like this one, it will tell you what the command does and all the arguments you need. (see [Command Syntax](./command-syntax) for how to read arguemnts)
:::info[`Permissions will be under Usage and will look like this. If there is no permission listed than eveyone can use the command`]
:::

## Details
Will give addtional information about arguments if needed.

## Limits
Will list any limits on how many of something there can be.

## Config
If the command has any default config it will be listed here and will give links on how to change any default behavior.

## Notes

:::danger
This is something that is important for the command and you should read.
:::
:::warning
This is used to give a warning about a command and like `danger` should be read.
:::
:::note
This will give you some details like when the command will work or anything that is usfull but not required.
:::
4 changes: 3 additions & 1 deletion docs/levels/disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ This command will not work if levels are already disabled on you server

## Usage
`/levels disable` Disables levels on your server.
:::info[`Manage Guild`]
:::

:::warning

This command does not delete any leveling related data, it just makes it so that the leveling system for you server is disabled. To delete leveling data see [deleting you data](../delete-my-data/levels)
This command does not delete any leveling related data, it just makes it so that the leveling system for you server is disabled. To delete leveling data see [deleting your data](../delete-my-data/levels)

:::
2 changes: 2 additions & 0 deletions docs/levels/enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This command will not work if levels are already enbaled on you server

## Usage
`/levels enable` Enableds levels on your server and sets up with the default config
:::info[`Manage Guild`]
:::

## Default Config
### Level Up Message
Expand Down
6 changes: 6 additions & 0 deletions docs/levels/set-message.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Set Level Up Message

## Usage
`/levels set-message` `<message:dynamic>`
:::info[`Manage Guild`]
:::
6 changes: 3 additions & 3 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const config: Config = {
organizationName: "helpr-bot", // Usually your GitHub org/user name.
projectName: "helpr-docs", // Usually your repo name.

onBrokenLinks: "warn",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
trailingSlash: false,

Expand Down Expand Up @@ -81,8 +81,8 @@ const config: Config = {
title: "Docs",
items: [
{
label: "Intro",
to: "/docs/intro",
label: "Getting Started",
to: "/docs/getting-started/command-syntax",
},
],
},
Expand Down
34 changes: 32 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,42 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Getting Started",
items: ["getting-started/command-syntax", "getting-started/dynamic-values"],
link: {
type: "generated-index",
title: "Getting Started",
slug: "getting-started",
},
items: ["getting-started/intro", "getting-started/command-syntax", "getting-started/dynamic-values"],
},
{
type: "category",
label: "Custom Commands",
link: {
type: "generated-index",
title: "Custom Commands",
slug: "custom-commands",
},
items: ["custom-commands/add"],
},
{
type: "category",
label: "Levels",
items: ["levels/enable", "levels/disable"],
link: {
type: "generated-index",
title: "Levels Commands",
slug: "levels",
},
items: ["levels/enable", "levels/disable", "levels/set-message"],
},
{
type: "category",
label: "Deleting Your Data",
link: {
type: "generated-index",
title: "Deleting Your Data",
slug: "delete-my-data",
},
items: ["delete-my-data/guild", "delete-my-data/user", "delete-my-data/custom-commands", "delete-my-data/levels"],
},
],
};
Expand Down

0 comments on commit c36aa58

Please sign in to comment.