Skip to content

Commit 8d2af23

Browse files
docs: edit quick start
1 parent 67e8547 commit 8d2af23

File tree

1 file changed

+54
-63
lines changed

1 file changed

+54
-63
lines changed
Lines changed: 54 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,113 @@
11
# Quick Start
22

3-
Get up and running with GitCord in minutes! This guide will show you how to create your first channels using templates.
3+
Get GitCord working in minutes!
44

5-
## Prerequisites
5+
## What You Need
66

7-
- GitCord bot installed and running (see [Installation](./installation.md))
8-
- Bot has proper permissions in your Discord server
9-
- You have administrator permissions in the server
7+
- GitCord bot running (see [Installation](./installation.md))
8+
- Bot has permissions in your Discord server
9+
- You have admin permissions
1010

11-
## Step 1: Create a Simple Channel Template
11+
## Step 1: Create a Channel
1212

13-
Create a file called `my-channels.yaml` with this content:
13+
Create a file called `general.yaml`:
1414

1515
```yaml
1616
name: general
1717
type: text
1818
topic: General discussion for the server
1919
position: 0
20+
nsfw: false
2021
```
2122
22-
## Step 2: Use the Create Command
23+
## Step 2: Create the Channel
2324
24-
In your Discord server, use the slash command:
25+
In your Discord server, use:
2526
2627
```
27-
/create-channel
28+
!createchannel
2829
```
2930

30-
Then upload your `my-channels.yaml` file when prompted.
31+
**Note:** This command uses a fixed file path. You'll need to put your file in the right place.
3132

3233
## Step 3: Create Multiple Channels
3334

34-
Create a more complex template with multiple channels:
35+
Create a category file:
3536

3637
```yaml
38+
# category.yaml
3739
name: community
3840
type: category
41+
position: 0
42+
3943
channels:
40-
- name: general
41-
type: text
42-
topic: General discussion
43-
- name: announcements
44-
type: text
45-
topic: Important announcements
46-
- name: voice-chat
47-
type: voice
48-
topic: Voice chat room
44+
- general
45+
- announcements
46+
- voice-chat
4947
```
5048
51-
Use the same `/create-channel` command with this template.
49+
Then create channel files for each channel listed.
5250
53-
## Step 4: Explore Built-in Templates
51+
## Step 4: Create the Category
5452
55-
GitCord comes with pre-built templates. Try:
53+
Use:
5654
5755
```
58-
/templates list
56+
!createcategory
5957
```
6058

61-
This shows available templates you can use immediately.
59+
Or with a specific path:
6260

63-
## Step 5: Use a Template
61+
```
62+
/createcategory path/to/category.yaml
63+
```
6464

65-
To use a built-in template:
65+
## Step 5: Try Basic Commands
6666

6767
```
68-
/templates use community
68+
!hello # Get a greeting
69+
!ping # Check bot latency
70+
!help # Show help information
6971
```
7072

71-
This creates a community category with general channels.
73+
## Example Templates
7274

73-
## Common Templates
74-
75-
### Community Template
75+
### Community Category
7676
```yaml
77+
# category.yaml
7778
name: community
7879
type: category
80+
position: 0
81+
7982
channels:
80-
- name: general
81-
type: text
82-
topic: General discussion
83-
- name: announcements
84-
type: text
85-
topic: Important announcements
86-
- name: memes
87-
type: text
88-
topic: Share your memes here
89-
- name: off-topic
90-
type: text
91-
topic: Off-topic discussions
83+
- general
84+
- announcements
85+
- memes
86+
- off-topic
9287
```
9388
94-
### Gaming Template
89+
### Voice Category
9590
```yaml
96-
name: gaming
91+
# category.yaml
92+
name: voice-chats
9793
type: category
94+
position: 1
95+
9896
channels:
99-
- name: general-gaming
100-
type: text
101-
topic: General gaming discussion
102-
- name: voice-chat
103-
type: voice
104-
topic: Gaming voice chat
105-
- name: game-announcements
106-
type: text
107-
topic: Game updates and announcements
97+
- vc1
98+
- vc2
10899
```
109100
110101
## Next Steps
111102
112103
- Learn about [Channel Management](../user-guide/channel-management.md)
113-
- Explore [Configuration](./configuration.md) options
114-
- Check out [Available Commands](../user-guide/commands.md)
115-
- Create [Custom Templates](../templates/custom-templates.md)
104+
- Explore [Categories](../user-guide/categories.md)
105+
- Check [Available Commands](../user-guide/commands.md)
106+
- Read about [Permissions](../user-guide/permissions.md)
116107
117108
## Tips
118109
119-
- Use descriptive channel names and topics
120-
- Organize channels into categories for better structure
121-
- Test templates in a private server first
122-
- Use the `/help` command to see all available options
110+
- Use clear, simple names
111+
- Test your YAML files first
112+
- Keep backups of your files
113+
- Use the `!help` command for more options

0 commit comments

Comments
 (0)