Skip to content

Commit 88003c4

Browse files
Aldiwildan77Aldiwildan77
committed
docs: add /subscribe, /bind, room tags, donut; update pricing and feedback; refresh index
1 parent d4e0340 commit 88003c4

8 files changed

Lines changed: 382 additions & 81 deletions

File tree

‎docs/commands/bind.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
sidebar_position: 4
3+
title: "/bind — Link Your Discord Account to Mocha"
4+
description: Use /bind to connect your Discord account to your Mocha SSO account, enabling access to the dashboard, subscriptions, and account-gated features.
5+
keywords:
6+
- /bind command
7+
- mocha sso
8+
- link discord account
9+
- mocha account
10+
- discord login
11+
---
12+
13+
# Bind
14+
15+
Link your Discord identity to your Mocha account. Required to access the [dashboard](https://dash.mocha-bot.xyz), manage subscriptions, and use account-gated features.
16+
17+
## Slash Commands
18+
19+
### Bind
20+
21+
Run this in any channel where the bot is present. The response is **ephemeral** — only you see it.
22+
23+
**Usage**
24+
25+
```md
26+
/bind
27+
```
28+
29+
**What you'll see**
30+
31+
An embed titled **Connect Your Account** with two buttons:
32+
33+
| Button | When to use |
34+
| ------ | ----------- |
35+
| **Login / Register** | You don't have a Mocha account yet. Opens the SSO page to create one using Discord OAuth. |
36+
| **Link Discord to Existing Account** | You already have a Mocha account (created with Google or another method) and want to attach your Discord identity to it. |
37+
38+
Both flows redirect back to your dashboard profile page after completion.
39+
40+
## Why bind your account?
41+
42+
- **Dashboard access** — [dash.mocha-bot.xyz](https://dash.mocha-bot.xyz) uses Mocha SSO. Without a linked account you cannot log in.
43+
- **Subscriptions** — plan purchases are tied to your Mocha account. Binding makes sure payments apply to the right profile.
44+
- **Private room gate** — some premium features require the subscribing user to have their Discord account linked.
45+
46+
## See also
47+
48+
- [/subscribe](/commands/subscribe) — view and upgrade your server's plan.
49+
- [Pricing](/web/pricing) — compare plans on the web.

‎docs/commands/feedback.md‎

Lines changed: 13 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,24 @@
11
---
2-
sidebar_position: 3
3-
title: "/feedback — Send Feedback to Mocha Developers"
4-
description: Use the /feedback slash command to send bug reports, suggestions, and feature requests directly to the Mocha developers from any Discord server.
2+
sidebar_position: 5
3+
title: "/feedback — Removed"
4+
description: The /feedback slash command has been removed. Use the Mocha support server or GitHub issues to send feedback.
55
keywords:
6-
- /feedback command
7-
- mocha bug report
8-
- mocha feature request
9-
- discord bot feedback
6+
- mocha feedback
7+
- mocha support
108
---
119

1210
# Feedback
1311

14-
Send feedback to the Mocha maintainers directly from Discord. The command opens a modal form that ends up as a formatted message in the developer channel, tagged with the server and user it came from so we can follow up if needed.
12+
:::caution Removed
13+
The `/feedback` slash command has been removed. It is no longer available in Discord.
14+
:::
1515

16-
## Slash Commands
16+
## How to send feedback now
1717

18-
### Feedback
19-
20-
**Usage**
21-
22-
```md
23-
/feedback
24-
```
25-
26-
**What happens next**
27-
28-
1. Mocha responds with an ephemeral modal titled **Send Feedback**.
29-
2. You fill in two fields.
30-
3. You submit — Mocha replies *"Thank you for your feedback!"* and forwards the details to the developer channel.
31-
32-
## Modal fields
33-
34-
| Field | Required | Limits | Description |
35-
| ---------- | -------- | -------------------- | ------------------------------------------------------------- |
36-
| **Type** | yes | 3–20 characters | One of `bug`, `suggestion`, `feature_request`, `other`. |
37-
| **Feedback** | yes | up to 2000 characters | Free-form description. Be specific — the more context, the better. |
38-
39-
If you type something that isn't one of the four known values for **Type**, Mocha will accept the submission and quietly categorise it as `other`. You don't need to worry about spelling it exactly.
40-
41-
## What the maintainers see
42-
43-
Your submission is posted to the developer channel as an embed containing:
44-
45-
- **Title** — "Received a feedback!"
46-
- **Description** — the body you typed.
47-
- **Color** — tinted by feedback type (bug, suggestion, feature_request, other each have their own color).
48-
- **Author** — your Discord tag and avatar.
49-
- **Type field** — the category.
50-
- **Guild field** — the server name and ID the feedback came from.
51-
- **User field** — your display name and user ID.
52-
- **Timestamp** — when you submitted.
53-
54-
## Writing effective feedback
55-
56-
To help us act on your report quickly:
57-
58-
- **Bugs** — include the command or action you ran, what you expected, what happened, and (if possible) the room ID.
59-
- **Suggestions / feature requests** — describe the problem you're trying to solve, not just the solution you have in mind. We can usually find a better fit for the underlying need.
60-
- **Other** — use this for questions, praise, or anything that doesn't fit the first three. We read all of it.
18+
- **Support server** — join [discord.mocha-bot.xyz](https://discord.mocha-bot.xyz) and post in the appropriate channel.
19+
- **GitHub issues** — open an issue at the Mocha GitHub repository for bug reports and feature requests.
6120

6221
## See also
6322

64-
- [Support server](https://discord.mocha-bot.xyz/) — real-time help from the community.
65-
- [Frequent Searches](/others/frequent-searches) — answers to the most common questions before you reach for `/feedback`.
23+
- [Frequent Searches](/others/frequent-searches) — answers to common problems.
24+
- [Getting Started](/tutorials/getting-started) — setup walkthrough.

‎docs/commands/room.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,39 @@ Join a room using an invitation code or alias. The channel must not already be c
132132
```md
133133
room invite join <code>
134134
```
135+
136+
### Tag
137+
138+
Manage topic tags on the current room. See [Room Tags](/rooms/tags) for the full reference.
139+
140+
All tag subcommands require the channel to be connected to a room. `set` and `remove` are **owner-only**.
141+
142+
#### tag list
143+
144+
Show the tags currently assigned to this room.
145+
146+
**Usage**
147+
148+
```md
149+
/room tag list
150+
```
151+
152+
#### tag set
153+
154+
Open a select menu to assign one or more tags to this room. Only the room owner can use this.
155+
156+
**Usage**
157+
158+
```md
159+
/room tag set
160+
```
161+
162+
#### tag remove
163+
164+
Open a select menu to remove one or more assigned tags. Only the room owner can use this.
165+
166+
**Usage**
167+
168+
```md
169+
/room tag remove
170+
```

‎docs/commands/subscribe.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
sidebar_position: 3
3+
title: "/subscribe — View and Upgrade Your Server Plan"
4+
description: Use /subscribe to check your server's current plan and active features, and to browse available premium plans with direct checkout links.
5+
keywords:
6+
- /subscribe command
7+
- mocha premium
8+
- mocha plans
9+
- discord bot subscription
10+
- upgrade mocha
11+
---
12+
13+
# Subscribe
14+
15+
Check your server's current plan and browse available premium plans — all without leaving Discord.
16+
17+
## Slash Commands
18+
19+
### Subscribe
20+
21+
Run this in any channel where the bot is present. The response is **ephemeral** — only you see it.
22+
23+
**Usage**
24+
25+
```md
26+
/subscribe
27+
```
28+
29+
**What you'll see**
30+
31+
1. **Current Server Plan** embed — lists every premium feature currently active on your server. If no plan is active the embed describes the Free plan and prompts you to upgrade.
32+
2. **Available Plans** embed (if plans are configured) — shows each active plan with its name, price, and included features.
33+
3. **Subscribe buttons** — one button per plan, each linking directly to that plan's checkout page. If no plans have a checkout URL configured, a generic **View Plans** button links to the dashboard pricing page.
34+
35+
**Active features shown**
36+
37+
| Feature key | Display label |
38+
| -------------------------------- | ------------------------------ |
39+
| `private_room` | Private Rooms |
40+
| `room_invitation` | Room Invitations |
41+
| `room_invitation_alias` | Custom Invitation Aliases |
42+
| `room_invitation_unlimited_option` | Unlimited Invitation Uses |
43+
| `personalization` | Personalized Messages |
44+
| `welcoming` | Welcome Messages |
45+
| `max_channels` | Extended Channel Limit |
46+
47+
Only features that are **active** on your server appear in the embed.
48+
49+
## When to use it
50+
51+
- **Check your plan** — quickly see which features your server has without opening a browser.
52+
- **Upgrade** — hit a feature gate mid-setup and want to subscribe immediately.
53+
- **Share with admins** — because the response is ephemeral you can run it anywhere, then copy the plan link to share with whoever controls billing.
54+
55+
## See also
56+
57+
- [Pricing](/web/pricing) — full plan comparison on the web.
58+
- [Rooms Overview](/rooms/overview) — feature gate reference.
59+
- [Personalization](/rooms/personalization) — one of the premium features unlocked by a plan.

‎docs/donut/overview.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
sidebar_position: 1
3+
title: Donut — Community Matchmaking
4+
description: Donut automatically pairs Discord community members for 1-on-1 or small-group interactions. Use it to run speed dating events, mentorship circles, icebreakers, and gaming brackets.
5+
keywords:
6+
- mocha donut
7+
- discord matchmaking
8+
- community pairing
9+
- 1-on-1 discord
10+
- speed dating discord
11+
- mentorship discord
12+
---
13+
14+
# Donut
15+
16+
Donut is Mocha's matchmaking feature. It automatically pairs registered members for 1-on-1 or small-group interactions — no manual bracket-building or spreadsheets needed.
17+
18+
## What it does
19+
20+
1. You create a named **match session**.
21+
2. Members register for the session (by Discord user ID or reference).
22+
3. You start the match — Donut pairs everyone instantly.
23+
4. Pairs are revealed. Odd-numbered groups get a 3-way pair so nobody is left out.
24+
5. You retrieve the pair list and notify members however you like.
25+
26+
## Use cases
27+
28+
| Use case | How Donut helps |
29+
| -------- | --------------- |
30+
| **Speed dating** | Rotate members through timed 1-on-1 chats in your community. |
31+
| **Mentorship circles** | Match newcomers with experienced members automatically. |
32+
| **Gaming brackets** | Auto-seed players into 1v1 match pairs for tournaments or scrims. |
33+
| **Icebreakers** | Randomly pair members for warm-up conversations at the start of an event. |
34+
35+
## Match lifecycle
36+
37+
A match moves through the following states:
38+
39+
```
40+
pending → running → finished
41+
↘ stopped
42+
```
43+
44+
| State | Meaning |
45+
| ----- | ------- |
46+
| `pending` | Match created, members can register. |
47+
| `running` | Match started, pairs have been generated. |
48+
| `finished` | All pairs have been marked as called/completed. |
49+
| `stopped` | Match was halted before all pairs finished. |
50+
51+
Each individual participant also has their own status: `pending` → `running` → `finished` / `stopped`.
52+
53+
## API overview
54+
55+
Donut is accessible via the Mocha REST API. All endpoints are under `/api/v1/match/`.
56+
57+
| Method | Endpoint | Description |
58+
| ------ | -------- | ----------- |
59+
| `POST` | `/api/v1/match` | Create a new match session. |
60+
| `GET` | `/api/v1/match/:serial` | Get match information and status. |
61+
| `POST` | `/api/v1/match/:serial/start` | Start the match — triggers auto-pairing. |
62+
| `POST` | `/api/v1/match/:serial/stop` | Stop the match. |
63+
| `GET` | `/api/v1/match/:serial/people` | List all registered participants. |
64+
| `POST` | `/api/v1/match/:serial/people` | Register participants. |
65+
| `DELETE` | `/api/v1/match/:serial/people` | Unregister participants. |
66+
| `GET` | `/api/v1/match/:serial/pairs` | Get generated pairs. |
67+
| `POST` | `/api/v1/match/:serial/call` | Mark a pair as completed. |
68+
69+
## Pairing algorithm
70+
71+
- Members are shuffled randomly when the match starts.
72+
- Pairs are 2-person by default.
73+
- If the total count is odd, the last group becomes a 3-person pair.
74+
- A single leftover member (only possible if count is 1) is not paired.
75+
76+
## Dashboard
77+
78+
You can manage match sessions from the [Mocha dashboard](https://dash.mocha-bot.xyz). A live demo of the pairing flow is available at [mocha-bot.xyz/donut](https://mocha-bot.xyz/donut).
79+
80+
## See also
81+
82+
- [Getting Started](/tutorials/getting-started) — invite the bot and set up your first room.
83+
- [Pricing](/web/pricing) — plan comparison.

‎docs/index.mdx‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,27 @@ That channel is now the owner of a new room. Share its ID (or an [invitation cod
3939

4040
## Reference
4141

42-
- [Commands](/category/commands) — every slash command Mocha understands.
42+
- [Commands](/category/commands) — every slash command Mocha understands, including `/subscribe`, `/bind`, and `/room tag`.
4343
- [Chat](/category/chat) — how messages, edits, replies, pins, mentions, and `!tmp` work.
44-
- [Rooms](/category/rooms) — invitations, ratings, personalization.
44+
- [Rooms](/category/rooms) — invitations, ratings, personalization, tags.
45+
- [Donut](/category/donut) — community matchmaking for 1-on-1 and small-group pairing events.
4546
- [Web](/category/web) — discover public rooms at [mocha-bot.xyz/search](https://mocha-bot.xyz/search) and compare plans on [Pricing](/web/pricing).
4647

48+
## Slash commands summary
49+
50+
| Command | Description |
51+
| ------- | ----------- |
52+
| `/help` | List available commands and confirm the bot is alive. |
53+
| `/room create` | Create a new room in the current channel. |
54+
| `/room join` | Join an existing room by ID. |
55+
| `/room disconnect` | Leave the current room. |
56+
| `/room switch` | Swap rooms in one command. |
57+
| `/room info` | View room details, ratings, and controls. |
58+
| `/room invite create/join` | Manage invitation codes. |
59+
| `/room tag list/set/remove` | Manage topic tags on the room. |
60+
| `/subscribe` | View your server plan and subscribe to a premium plan. |
61+
| `/bind` | Link your Discord account to your Mocha SSO account. |
62+
4763
## Reporting issues
4864

4965
If you're having issues with the bot, check the [Frequent Searches](/others/frequent-searches) page. If you can't find a solution, join the [support server](https://discord.mocha-bot.xyz/) and ask for help there.
50-
51-
## Making suggestions
52-
53-
Use the [`/feedback`](/commands/feedback) slash command from any server the bot is in, or drop a message in the [support server](https://discord.mocha-bot.xyz/).

0 commit comments

Comments
 (0)