Update Home

2025-10-06 23:20:39 +10:00
parent d6a77dbb0e
commit e644a7232c

25
Home.md

@@ -4,6 +4,12 @@ Our tasklist system helps you track and share your current task (`!now`),
plan your future tasks (`!plan`),
and review your completed task history along with how long each task took (`!history`).
All commands below are available in *both* Discord and Twitch, unless marked otherwise.
If you want to have the same tasklist between Discord and Twitch,
you need to run `/profiles link twitch` so that the bot knows who you are.
If multiple Discord accounts are linked to the same Twitch account,
all their tasklists will be shared as well.
**Note:** All commands use the `!` prefix (e.g., `!now`).
---
@@ -36,11 +42,6 @@ Or sometimes half way through one task, you need to start another one,
but you don't want to lose the first task or the time tracked on it (`!sidequest`).
Now presenting to you, your `!plan`!
This feature is under active development, so there may be some mild instability or deviations
from what is written here until I can get the documentation updated, sorry about that!
If there are any features you would like to see added or changed,
or anything you find confusing, please let me know so everyone can benefit from improvements!
Candid feedback is *always* welcome.
In the below table, `taskspec` stands for a specification of one or more tasks in any of the following forms:
@@ -56,6 +57,12 @@ We generally recommend avoiding using commas in your tasks, but if you need to
you can take advantage of this behaviour by using trailing semicolons, for example,
`!now this, that;` will set your current task to just `this, that`.
Another Note: This feature is under active development, so there may be some mild instability or deviations
from what is written here until I can get the documentation updated, sorry about that!
If there are any features you would like to see added or changed,
or anything you find confusing, please let me know so everyone can benefit from improvements!
Candid feedback is *always* welcome.
| Command | Description | Example |
| --------------- | --------------- | --------------- |
| `!now <taskspec>` | Set your current task(s). If multiple are given, all tasks are added to the *start* of your plan. | `!now Read; Write` |
@@ -169,7 +176,7 @@ NOTE: Soon to be `!edit [n] <new content>` for editing a task that is not your c
---
### ### `!sidequest <taskspec>`
### `!sidequest <taskspec>`
Put your current task on the head of the plan, and start a new task.
@@ -202,7 +209,7 @@ View your remaining planned tasks, or add tasks to the *end* of your plan.
- `!plan`
- Replies: `You have 2 tasks on the plan, good luck: #14: Grade assignments ┆ #15: Buy groceries`
- `!plan Go to the gym; 15`
- Adds "Go to the gym" to the end of your plan, and moved `15` to the end after that. The result will be:
- Adds "Go to the gym" to the end of your plan, and moves `15` to the end after that. The result will be:
- `#14: Grade assignments ┆ #16: Go to the gym ┆ #15: Buy groceries`
---
@@ -229,5 +236,7 @@ Displays a detailed history of your completed tasks, grouped by day.
- **Aliases:** `!hist`, `!taskhist`
- **Platform:** Discord only.
- For the days and task times to be correct, you will need to set your timezone with the Discord command `/my timezone`, and choose from the list.
- Note: If you have completed too many tasks in a day, there is a known issue that `!hist` will fail to show that day. This will be addressed soon.
This command generates paginated tables showing which tasks you completed on which days, including start/end times and total duration.
This command generates paginated tables showing which tasks you completed on each day, including start/end times and total duration.