docs: run /speckit.checklist after /speckit.plan in quickstart#3108
docs: run /speckit.checklist after /speckit.plan in quickstart#3108jawwad-ali wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR resolves the docs-vs-CLI contradiction around when to run /speckit.checklist by updating the Quick Start workflow so the checklist step comes after /speckit.plan, matching the CLI’s intended next-steps guidance.
Changes:
- Reordered the Recommended Workflow diagram to place
/speckit.checklistafter/speckit.plan. - Updated the “quality gates” prose to describe checklist usage after a plan exists.
- Reordered both walkthroughs so the plan step precedes the checklist validation step.
Show a summary per file
| File | Description |
|---|---|
| docs/quickstart.md | Moves /speckit.checklist to after /speckit.plan across the workflow diagram, explanatory prose, and both walkthroughs to align docs with CLI guidance. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
|
Addressed both Copilot comments in 16acb01 — reworded so
Disclosure: this update and comment were prepared with Claude Code (Claude Opus 4.8) under my direction; I reviewed the changes before pushing. |
|
Thanks — addressed all three in a48da73, aligning the wording with the CLI next-steps text:
Disclosure: prepared with Claude Code (Claude Opus 4.8) under my direction; reviewed before pushing. |
|
Please address test & lint errors. You might have to pull in upstream/main |
The quickstart workflow showed /speckit.checklist before /speckit.plan, contradicting the CLI next-steps text (commands/init.py), which lists the checklist as running after the plan. Per the maintainer on github#2816 — "the docs were actually wrong here ... checklists are meant for after plan" — align the docs to the CLI: move /speckit.checklist after /speckit.plan in the workflow diagram, the prose, and both walkthrough step sequences. Docs-only; no behavior change. Closes github#2606 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ng directly Address review: /speckit.checklist generates quality checklists (which then validate the requirements) rather than validating directly, matching the CLI/README phrasing. Preserves the after-plan ordering. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Address review: state the checklist's purpose (validate requirements completeness, clarity, and consistency) and anchor it to /speckit.plan as the CLI does, use the plural 'quality checklists', and reword the Taskify step so the spec is validated using the generated checklists. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
a48da73 to
b541db6
Compare
|
Rebased onto the latest |
Description
Closes #2606.
The quickstart showed
/speckit.checklistbefore/speckit.plan, while the CLI's own next-steps panel (src/specify_cli/commands/init.py) describes the checklist as running after the plan. #2606 flagged this docs-vs-CLI contradiction.The maintainer already settled the direction on the (closed) PR #2816:
This PR aligns the docs to the CLI (which is correct) by moving
/speckit.checklistto after/speckit.planindocs/quickstart.md:… -> /speckit.clarify -> /speckit.plan -> /speckit.checklist -> /speckit.tasks -> …),/speckit.clarifystays before planning (matches the CLI). Docs-only — no CLI, behavior, or output change.Testing
Tested locally with
uv run specify --help(exit 0)Ran existing tests with
uv sync && uv run pytest(N/A — docs-only change, no Python touched)Tested with a sample project (N/A)
npx markdownlint-cli2 docs/quickstart.md— 0 errorsgit diff --check— cleanVerified the rendered ordering now matches the CLI next-steps text in
commands/init.py(clarifybefore plan;checklistafter plan;analyzeafter tasks).AI Disclosure
Prepared with Claude Code (Claude Opus 4.8) under my direction. AI cross-checked the docs against the CLI next-steps source and the maintainer's direction on #2816, made the edits, and ran markdownlint. I reviewed the diff and confirmed the new ordering matches the CLI before submitting. I'll disclose if any review responses are AI-assisted as well.