docs: remove v5 PLAN.md artifacts and complete README command table#176
docs: remove v5 PLAN.md artifacts and complete README command table#176maystudios merged 1 commit intomainfrom
Conversation
Replace all PLAN.md references with GitHub Issue comment equivalents across website docs and Hero terminal animation. Add 4 missing commands (debug-loop, fix-loop, improve, security) to the README command table. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates documentation and README copy to reflect the GitHub-first planning workflow (plans stored as GitHub Issue comments rather than local PLAN.md artifacts), and completes the public command list.
Changes:
- Replace
PLAN.mdreferences with “GitHub Issue plan comments” language in website docs. - Update the Hero terminal animation text to reflect publishing plans to GitHub.
- Add missing commands (
debug-loop,fix-loop,improve,security) and fix a stale planning reference in the README.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/website/src/content/docs/gap-closure.md | Updates gap-closure description to reference GitHub Issue plan comments. |
| packages/website/src/content/docs/commands-phases.md | Updates phase planning/execution docs to describe GitHub Issue comment plans (needs minor terminology fix noted in comment). |
| packages/website/src/components/sections/Hero.tsx | Updates terminal mock output to show GitHub publishing instead of generating PLAN.md. |
| README.md | Adds missing commands to the command table and updates Planner description to GitHub plan comments. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| {% /codeblock %} | ||
|
|
||
| Each PLAN.md is a structured document with frontmatter (phase, plan number, type, wave, dependencies), an objective, task breakdown with type annotations, verification criteria, and success conditions. | ||
| Each plan is a structured GitHub Issue comment with frontmatter (phase, plan number, type, wave, dependencies), an objective, task breakdown with type annotations, verification criteria, and success conditions. |
There was a problem hiding this comment.
The docs list dependencies as a plan frontmatter field, but the plan templates/agent contract use depends_on (e.g., templates/templates/phase-prompt.md and templates/agents/planner.md). To avoid misleading users, update this line to reference depends_on (and optionally match the exact key names like plan: rather than “plan number”).
| Each plan is a structured GitHub Issue comment with frontmatter (phase, plan number, type, wave, dependencies), an objective, task breakdown with type annotations, verification criteria, and success conditions. | |
| Each plan is a structured GitHub Issue comment with frontmatter (phase, plan, type, wave, depends_on), an objective, task breakdown with type annotations, verification criteria, and success conditions. |
|
🎉 This PR is included in version 5.13.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Summary
PLAN.mdreferences with GitHub Issue comment equivalents in website docs (commands-phases.md,gap-closure.md)debug-loop,fix-loop,improve,security) to the README command tablePLAN.mdreference in the README Agents table (Planner row)Test plan
🤖 Generated with Claude Code