Skip to content

Commit 89508f9

Browse files
docs: user-guide categories
1 parent ecc057a commit 89508f9

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

docs/src/user-guide/categories.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
11
# Categories
2+
3+
Categories group related channels together in Discord. GitCord lets you create categories using YAML files.
4+
5+
## What Are Categories?
6+
7+
Categories are folders that hold channels. They help organize your server and make it look cleaner.
8+
9+
## Creating Categories
10+
11+
### Basic Category
12+
```yaml
13+
name: Community
14+
position: 0
15+
type: category
16+
17+
channels:
18+
- general
19+
- memes
20+
- off-topic
21+
```
22+
23+
### Required Fields
24+
- `name`: Category name
25+
- `position`: Where it appears (0 = top)
26+
- `type`: Must be "category"
27+
- `channels`: List of channel files (without .yaml)
28+
29+
## How to Use
30+
31+
1. Create a category YAML file
32+
2. Create channel YAML files for each channel
33+
3. Run `!createcategory` or `/createcategory`
34+
35+
## Examples
36+
37+
### Community Category
38+
```yaml
39+
# community.yaml
40+
name: Community
41+
position: 0
42+
type: category
43+
44+
channels:
45+
- general
46+
- memes
47+
- off-topic
48+
```
49+
50+
### Voice Category
51+
```yaml
52+
# voice.yaml
53+
name: Voice Chats
54+
position: 1
55+
type: category
56+
57+
channels:
58+
- vc1
59+
- vc2
60+
```
61+
62+
## Channel Files
63+
64+
Each channel listed in the category needs its own YAML file:
65+
66+
```yaml
67+
# general.yaml
68+
name: general
69+
type: text
70+
position: 0
71+
topic: "General chat for everyone"
72+
```
73+
74+
## Tips
75+
76+
- Use clear, simple names
77+
- Position categories logically
78+
- Keep related channels together
79+
- Test your setup first

0 commit comments

Comments
 (0)