Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/USER-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ rapid prototyping phases where test infrastructure isn't the focus.
| `/maxsim:map-codebase` | Analyze existing codebase | Before `/maxsim:new-project` on existing code |
| `/maxsim:quick` | Ad-hoc task with MAXSIM guarantees | Bug fixes, small features, config changes |
| `/maxsim:debug [desc]` | Systematic debugging with persistent state | When something breaks |
| `/maxsim:add-todo [desc]` | Capture an idea for later | Think of something during a session |
| `/maxsim:check-todos` | List pending todos | Review captured ideas |
| `/maxsim:quick --todo "desc"` | Capture an idea as a GitHub Issue | Think of something during a session |
| `/maxsim:quick --todo list` | List pending todos from GitHub | Review captured ideas |
Comment on lines +200 to +201
Copy link

Copilot AI Mar 12, 2026

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 --todo workflow 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.

Suggested change
| `/maxsim:quick --todo "desc"` | Capture an idea as a GitHub Issue | Think of something during a session |
| `/maxsim:quick --todo list` | List pending todos from GitHub | Review captured ideas |
| `/maxsim:quick --todo "desc"` | Capture an idea as a todo (GitHub Issue when configured, otherwise local) | Think of something during a session |
| `/maxsim:quick --todo list` | List pending todos (from GitHub or local cache) | Review captured ideas |

Copilot uses AI. Check for mistakes.
| `/maxsim:settings` | Configure workflow toggles and model profile | Change model, toggle agents |
| `/maxsim:set-profile <profile>` | Quick profile switch | Change cost/quality tradeoff |
| `/maxsim:reapply-patches` | Restore local modifications after update | After `/maxsim:update` if you had local edits |
Expand Down
14 changes: 4 additions & 10 deletions packages/website/src/components/sections/Docs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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.`,
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description implies --todo always creates/uses GitHub Issues, but the canonical command spec indicates GitHub is primary with a local .planning/todos/* cache and a local-only fallback when GitHub isn’t available. Consider updating the wording here to reflect that behavior so the website docs stay consistent with the command template.

Suggested change
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.`,

Copilot uses AI. Check for mistakes.
example: `/maxsim:quick --todo "Refactor auth module"`,
},
{
name: "dashboard",
Expand Down
20 changes: 13 additions & 7 deletions packages/website/src/content/docs/commands-todos.md
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.
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page states GitHub Issues are the sole source of truth and that “no local files are involved”, but the current quick todo workflow still initializes and maintains a local cache under .planning/todos/* (and can fall back to local-only when GitHub isn’t available). Update this text to match the actual behavior (or update the workflow if the intent is to remove the local cache).

Suggested change
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.

Copilot uses AI. Check for mistakes.

{% codeblock language="bash" %}
# Save an idea as a todo (from conversation context)
/maxsim:add-todo
# Capture an idea as a GitHub Issue
/maxsim:quick --todo "Refactor auth module to use refresh tokens"

# Review and pick a todo to work on
/maxsim:check-todos
# List pending todos (open Issues labeled 'todo')
/maxsim:quick --todo list

# Mark a todo complete by closing Issue #12
/maxsim:quick --todo done 12

# Triage: prioritize todos against the current roadmap
/maxsim:quick --todo triage
{% /codeblock %}
Loading