Skip to content

docs: replace stale add-todo/check-todos refs with quick --todo#79

Open
maystudios wants to merge 1 commit intomainfrom
worktree-agent-aa7f1b54
Open

docs: replace stale add-todo/check-todos refs with quick --todo#79
maystudios wants to merge 1 commit intomainfrom
worktree-agent-aa7f1b54

Conversation

@maystudios
Copy link
Owner

Summary

  • Remove all references to the deleted /maxsim:add-todo and /maxsim:check-todos commands from docs/USER-GUIDE.md, packages/website/src/content/docs/commands-todos.md, and packages/website/src/components/sections/Docs.tsx
  • Replace with the current /maxsim:quick --todo workflow that uses GitHub Issues as the sole source of truth
  • The commands-todos.md page is rewritten to document all four subcommands: capture, list, done, and triage

Test plan

  • grep -rn "add-todo|check-todos" docs/ packages/website/ returns zero results
  • Build passes (npm run build)
  • Lint passes (npm run lint)
  • Unit tests pass — 210/210

🤖 Generated with Claude Code

Remove all references to the deleted /maxsim:add-todo and
/maxsim:check-todos commands in USER-GUIDE.md, commands-todos.md, and
Docs.tsx. Replace with the current /maxsim:quick --todo workflow backed
by GitHub Issues as the sole source of truth.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 12, 2026 16:30
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the MAXSIM documentation surface to remove references to deprecated todo commands and document the newer /maxsim:quick --todo workflow.

Changes:

  • Rewrites the todo commands doc page to describe /maxsim:quick --todo subcommands (capture/list/done/triage).
  • Updates the website “Commands” section to replace add-todo / check-todos with a quick --todo entry.
  • Updates the main user guide command table to reference quick --todo capture and list.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
packages/website/src/content/docs/commands-todos.md Replaces old todo command docs with /maxsim:quick --todo-based documentation.
packages/website/src/components/sections/Docs.tsx Updates the website command list to remove deprecated todo commands and add quick --todo.
docs/USER-GUIDE.md Updates the command reference table to point at quick --todo capture/list instead of deleted commands.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

{% /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.
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.
Comment on lines +200 to +201
| `/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 |
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants