Skip to content

Commit 6f28921

Browse files
committed
docs(commands): update doc for explain reminder and reminder subscription command
1 parent bd2edc1 commit 6f28921

1 file changed

Lines changed: 46 additions & 9 deletions

File tree

docs/guides/commands.md

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -199,24 +199,34 @@ Release your assignment from the ticket.
199199

200200
## Reminders
201201

202-
### add_reminder
202+
### remind
203203

204-
Set a reminder for the current ticket.
204+
Set a reminder for the current ticket. Reminders can target yourself or specific roles.
205205

206-
| Slash | Text |
207-
|----------------------------------|----------------------------------|
208-
| `/add_reminder <time> [content]` | `!add_reminder <time> [content]` |
206+
| Slash | Text |
207+
|------------------------------------------|---------------------------------------------|
208+
| `/remind <time> <content> [roles]` | `!rem <time> [@roles] [content]` |
209209

210210
**Parameters:**
211-
- `time` - When to trigger (e.g., `30m`, `2h`, `1d`)
212-
- `content` - Optional reminder message
211+
- `time` - When to trigger in HH:MM format (e.g., `14:30`, `09:00`)
212+
- `content` - Reminder message
213+
- `roles` - Optional: roles to ping when the reminder triggers
213214

214215
**Examples:**
215216
```
216-
/add_reminder time:1h content:Follow up with user
217-
!add_reminder 1h Follow up with user
217+
/remind time:14:30 content:Follow up with user
218+
/remind time:09:00 content:Team meeting roles:@dev,@mod
219+
220+
!rem 14:30 Follow up with user
221+
!rem 14:30 @dev @mod Team meeting
222+
!rem 09:00 @support Check ticket status
218223
```
219224

225+
**Notes:**
226+
- If the specified time has already passed today, the reminder will be scheduled for tomorrow
227+
- When targeting roles, only members who are subscribed to that role's reminders will be pinged
228+
- You can use Discord role mentions or `@rolename` syntax in text commands
229+
220230
### remove_reminder
221231

222232
Cancel a scheduled reminder.
@@ -225,9 +235,36 @@ Cancel a scheduled reminder.
225235
|----------------------------------|----------------------------------|
226236
| `/remove_reminder <reminder_id>` | `!remove_reminder <reminder_id>` |
227237

238+
Aliases: `!unremind`, `!urem`
239+
228240
**Parameters:**
229241
- `reminder_id` - ID of the reminder to cancel
230242

243+
### reminder_subscription
244+
245+
Manage your role-based reminder subscriptions. By default, you receive pings for all roles you have. Use this to opt out of specific role reminders.
246+
247+
| Slash | Text |
248+
|-------------------------------------------------|---------------------------------|
249+
| `/reminder_subscription <action> <role>` | `!rem subscribe <role>` |
250+
| | `!rem unsubscribe <role>` |
251+
252+
**Parameters:**
253+
- `action` - Either `subscribe` or `unsubscribe`
254+
- `role` - The role to manage subscription for
255+
256+
**Requirements:**
257+
- You must have the role to modify your subscription for it
258+
259+
**Examples:**
260+
```
261+
/reminder_subscription action:unsubscribe role:@dev
262+
/reminder_subscription action:subscribe role:@support
263+
264+
!rem unsubscribe dev
265+
!rem subscribe @support
266+
```
267+
231268
---
232269

233270
## Alerts

0 commit comments

Comments
 (0)