Document the complete workflow in flow, artifact, and reference views - #54
Merged
Merged
Conversation
docs/workflow.md shows the overview, planning, and feature flows with their loops as Mermaid diagrams, an artifact figure per phase (committed, working file, or GitHub), and a reference table per step. New docs/project-map.md explains every file and docs/example.md walks a sample project through the whole workflow. The README links to them, and duplicate lifecycle descriptions are replaced by references. start-planning.sh now ends by pointing to the planning review, and a verification check keeps the project map complete. Closes #53 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
docs/workflow.md:FIX_NOWfindings, and escalations.verify.shsay so.verify.sh), the checks that stop each step, and the helper scripts.docs/project-map.md: what every rule file, document, script, library, contract, schema, and working directory is for.docs/example.md: a sample project (a household recipe box) through every step, with the commands, prompts, and resulting files and GitHub items.docs/agentic-workflow.mdanddocs/development.md: duplicate lifecycle descriptions replaced by references todocs/workflow.md.start-planning.shnow ends by pointing toreview-planning.shinstead of the old commit steps.docs-scripts: every script and library must appear in the project map.Issue / acceptance criteria
Closes #53
Risk
Verification evidence
./scripts/verify.shpassed, also without global or system Git configurationscripts/verify.conf)All six Mermaid diagrams (README and
docs/workflow.md) were parsed and rendered with Mermaid 11 in a browser. They have not been viewed on GitHub itself yet.The worked example follows the scripts' prompts and messages, but has not been run end to end with real agents and a real GitHub repository.
Independent review: Codex (
gpt-6-astra), read-only. PASS WITH MINOR FINDINGS; all four fixed:cdinto each worktree and the re-review before finishing.start-planning.shcan resume a planning worktree; it describes the manual route and says that no script exists for it yet.Agent involvement
Planner: —
Implementer: Claude (Opus 5.5)
Reviewer: Codex (gpt-6-astra)
Production impact
None.
🤖 Generated with Claude Code