Docs/flow charts - #11
Merged
Merged
Conversation
The README chart shows which entry point to pick; nothing showed what happens after picking one. commands.md is a reference - it answers what a command takes and produces, not the order things happen in or where the process stops for you. flows.md covers map's mode select and the stamp-versus-git-diff refresh, start's seven gated interviews plus the readback's two halves, and the feature chain through its recursive review loop to the wrap that absorbs the spec and deletes the folder. Plus the mechanics all three share: the interview lifecycle, and why the changelog entry is written before the done marker rather than after. Eight diagrams, each rendered through mermaid-cli before committing.
Five of the eight were linear: a flowchart of "A then B then C" costs a render and a scroll to say what a numbered list says in place. The pipeline and the feature chain are tables now - stage, what it settles, what it produces - which also carries more than the boxes did, since a box has room for a name and an arrow has room for nothing. The three that survive have real forks or a cycle: map's mode select, the interview lifecycle, and the review loop. Those are the shapes prose genuinely struggles with.
There was a problem hiding this comment.
Sorry @GentBajko, you've used your own review budget of 250,000 diff characters for the last 7 days.
You can request another review in 5 days and 9 hours by commenting @sourcery-ai review. Upgrade to get a review now.
Reviewer's GuideAdds a detailed, diagram-driven guide to how map, start, and feature execute, including their gates, artifacts, recovery semantics, and shared stage behavior, and links it from the main documentation. State diagram for gated stage completionstateDiagram-v2
[*] --> interviewing: first question asked
interviewing --> awaiting_formalization: summary presented
awaiting_formalization --> interviewing: user amends
awaiting_formalization --> formalized: user approves and outputs are written
formalized --> [*]
Flow diagram for the map commandflowchart TD
A([map]) --> B{Phase 0 mode select}
B -->|map check| C[Read-only report]
B -->|Topic name| D[Build one chapter]
B -->|map rebuild or no index| E[Full build]
B -->|Existing index| F{Stamped files changed?}
F -->|No| G[Leave unchanged]
F -->|Yes or coverage gap| D
E --> D
D --> H[(Index and chapters)]
C --> I[(Nothing written)]
Flow diagram for the start pipelineflowchart LR
A([start]) --> B[mockup]
B --> C[logic]
C --> D[uiux]
D --> E[architecture]
E --> F[standards]
F --> G[stack]
G --> H[readback]
H --> I{Build approved?}
I -->|No| J[Amend plan]
J --> I
I -->|Yes| K[build]
K --> L[(Implementation plan and source)]
Flow diagram for the feature lifecycleflowchart LR
A([feature]) --> B[groom]
B --> C{Spec approved?}
C -->|No| B
C -->|Yes| D[plan]
D --> E{Plan approval matches spec?}
E -->|No| D
E -->|Yes| F[implement]
F --> G[Review loop]
G --> H{Findings survive verification?}
H -->|Yes| I[Fix implementation]
I --> G
H -->|No| J{Enough dry rounds?}
J -->|No| G
J -->|Yes| K[Refresh and absorb chapters]
K --> L[(Changelog entry)]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Summary by Sourcery
Document how each capstone workflow progresses from entry point through approval, generation, and completion.
New Features:
map,start, andfeatureentry points.Enhancements:
Documentation: