Skip to content

Commit ac17f6a

Browse files
committed
docs: document category selection feature and commands
1 parent dc94c52 commit ac17f6a

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/guides/commands.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ Check bot responsiveness.
3737

3838
## Ticket Management
3939

40+
### category
41+
42+
Manage ticket categories that users can select to direct their requests.
43+
44+
| Slash | Text |
45+
|-------|------|
46+
| `/category <subcommand>` | `!category <subcommand>` |
47+
48+
**Subcommands:**
49+
- `create` - Create a new category
50+
- `list` - List all configured categories
51+
- `rename` - Rename an existing category
52+
- `move` - Change the position of a category
53+
- `delete` / `remove` - Delete a category
54+
- `enable` / `disable` - Enable or disable a specific category
55+
- `on` / `off` - Enable or disable the entire category selection feature
56+
- `timeout` - Set the time limit (in seconds) users have to select a category before defaulting
57+
4058
### new_thread
4159

4260
Create a new ticket for a user. Use when you need to initiate contact.

docs/guides/tickets.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,21 @@ Cancel an alert:
267267
!alert cancel
268268
```
269269

270+
## Category Selection
271+
272+
You can configure Rustmail to ask users to choose a category before their ticket is opened. This allows you to route tickets directly to specialized teams (e.g., Support, Billing, Escalations).
273+
274+
### Managing Categories
275+
276+
Staff can manage categories using the `/category` or `!category` command:
277+
278+
- `!category create <discord_id> <name> | <description> | <emoji>` - Create a new category
279+
- `!category list` - View existing categories
280+
- `!category on` / `off` - Enable or disable the category prompt globally
281+
- `!category timeout <seconds>` - Change how long the bot waits for the user to make a choice before routing to the default inbox category.
282+
283+
When the category prompt is enabled, the bot will hold the user's initial messages in a queue and present them with interactive buttons. Once a category is selected (or the timeout expires), all queued messages are forwarded to the newly created ticket channel.
284+
270285
---
271286

272287
## Moving Tickets

0 commit comments

Comments
 (0)