-
Notifications
You must be signed in to change notification settings - Fork 1
docs: replace stale add-todo/check-todos refs with quick --todo #79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -322,16 +322,10 @@ const commands: CommandDef[] = [ | |||||
| example: `/maxsim:map-codebase`, | ||||||
| }, | ||||||
| { | ||||||
| name: "add-todo", | ||||||
| signature: "/maxsim:add-todo", | ||||||
| description: "Capture an idea or task as a todo from the current conversation context. Stored in .planning/todos/pending/.", | ||||||
| example: `/maxsim:add-todo`, | ||||||
| }, | ||||||
| { | ||||||
| name: "check-todos", | ||||||
| signature: "/maxsim:check-todos", | ||||||
| description: "List all pending todos and interactively select one to work on next.", | ||||||
| example: `/maxsim:check-todos`, | ||||||
| name: "quick --todo", | ||||||
| signature: `/maxsim:quick --todo "desc"`, | ||||||
| description: `Capture a task or idea as a GitHub Issue (label: todo). Use --todo list to view open todos, --todo done N to close Issue #N, or --todo triage to prioritize against the roadmap.`, | ||||||
|
||||||
| description: `Capture a task or idea as a GitHub Issue (label: todo). Use --todo list to view open todos, --todo done N to close Issue #N, or --todo triage to prioritize against the roadmap.`, | |
| description: `Capture a task or idea as a todo. Uses GitHub Issues (label: todo) when available with a .planning/todos/* cache, and falls back to local-only todos if GitHub can't be reached. Use --todo list to view open todos, --todo done N to mark todo N done, or --todo triage to prioritize against the roadmap.`, |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,18 +1,24 @@ | ||||||
| --- | ||||||
| id: commands-todos | ||||||
| title: Todo Commands | ||||||
| title: Todo Management | ||||||
| group: Commands Reference | ||||||
| --- | ||||||
|
|
||||||
| {% doctable headers=["Command", "Description"] rows=[["/maxsim:add-todo", "Capture an idea or task from the current conversation as a todo file"], ["/maxsim:check-todos", "List pending todos and interactively select one to work on next"]] %} | ||||||
| {% doctable headers=["Command", "Description"] rows=[["/maxsim:quick --todo \"desc\"", "Capture a task or idea as a GitHub Issue with label 'todo'"], ["/maxsim:quick --todo list", "Show open todo Issues from GitHub"], ["/maxsim:quick --todo done N", "Close GitHub Issue #N as completed"], ["/maxsim:quick --todo triage", "Prioritize todos and cross-reference with the roadmap"]] %} | ||||||
| {% /doctable %} | ||||||
|
|
||||||
| Todos are stored as markdown files in `.planning/todos/pending/`. Each todo has a title, description, priority, and creation timestamp. Completed todos move to `.planning/todos/completed/`. | ||||||
| Todo management uses GitHub Issues as the sole source of truth. Todos are created as Issues with the `todo` label and closed when completed — no local files are involved. | ||||||
|
||||||
| Todo management uses GitHub Issues as the sole source of truth. Todos are created as Issues with the `todo` label and closed when completed — no local files are involved. | |
| Todo management uses GitHub Issues as the primary source of truth. Todos are created as Issues with the `todo` label and closed when completed. A local cache under `.planning/todos/` is maintained to speed up operations and allow limited use when GitHub is temporarily unavailable, and is synchronized with GitHub when possible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This row says todo capture happens “as a GitHub Issue”, but the current
--todoworkflow uses GitHub as the primary target with a local.planning/todos/*cache and can fall back to local-only if GitHub isn’t configured/available. Consider adjusting the wording to avoid implying GitHub is always required.