removed metadata and added basic structure to usage section
This commit is contained in:
parent
8415569e81
commit
b08699c6ad
2 changed files with 44 additions and 5 deletions
|
@ -1,7 +1,31 @@
|
||||||
---
|
|
||||||
sidebar_position: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
# Overview
|
# Overview
|
||||||
|
|
||||||
Work in Progress...
|
Work in progress...
|
||||||
|
|
||||||
|
Explain:
|
||||||
|
|
||||||
|
- what bots are
|
||||||
|
- what commands are
|
||||||
|
- what prefixes are
|
||||||
|
- ping prefix
|
||||||
|
- default prefix
|
||||||
|
- how different servers can have different prefixes
|
||||||
|
|
||||||
|
## How to read documentation
|
||||||
|
|
||||||
|
Arguments are extra information that are passed with the command. A command can have any number arguments and they could either be required or optional.
|
||||||
|
|
||||||
|
### Searching
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
|
||||||
|
#### Required arguments
|
||||||
|
|
||||||
|
#### Optional arguments
|
||||||
|
|
||||||
|
#### Examples
|
||||||
|
|
||||||
|
- `command <arg1>`: a required argument
|
||||||
|
- `command <arg1> [arg2]`: a required argument and a optional one
|
||||||
|
- `command [args]*`: arbitrary amount of optional arguments
|
||||||
|
- `command [<arg1> <arg2>]`: either both or neither
|
||||||
|
|
15
docs/2-usage/2-commands.md
Normal file
15
docs/2-usage/2-commands.md
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# Commands
|
||||||
|
|
||||||
|
## `help`
|
||||||
|
|
||||||
|
The most basic command and the a easy way to get information about a command/command category.
|
||||||
|
|
||||||
|
If no argument is passed, this command will list all command categories regardless of whether it is enabled or not.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### `help <category>`
|
||||||
|
|
||||||
|
### `help <command>`
|
||||||
|
|
||||||
|
## `ping`
|
Loading…
Add table
Add a link
Reference in a new issue