Skip to content

Docs/flow charts - #11

Merged
GentBajko merged 2 commits into
mainfrom
docs/flow-charts
Aug 31, 2026
Merged

Docs/flow charts#11
GentBajko merged 2 commits into
mainfrom
docs/flow-charts

Conversation

@GentBajko

@GentBajko GentBajko commented Aug 31, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Document how each capstone workflow progresses from entry point through approval, generation, and completion.

New Features:

  • Add end-to-end flow diagrams and guidance for the map, start, and feature entry points.

Enhancements:

  • Document command selection, stage sequencing, approval gates, persistence, resumability, and generated-output lifecycle across the three workflows.

Documentation:

  • Link the new flow documentation from the README and command reference.

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.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

@GentBajko
GentBajko merged commit 1814940 into main Aug 31, 2026
1 check passed
@GentBajko
GentBajko deleted the docs/flow-charts branch August 31, 2026 14:35
@sourcery-ai

sourcery-ai Bot commented Aug 31, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds 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 completion

stateDiagram-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 --> [*]
Loading

Flow diagram for the map command

flowchart 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)]
Loading

Flow diagram for the start pipeline

flowchart 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)]
Loading

Flow diagram for the feature lifecycle

flowchart 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)]
Loading

File-Level Changes

Change Details Files
Add end-to-end flow documentation for the three primary Capstone workflows.
  • Introduce a new guide explaining entry-point selection, outputs, sequencing, resumability, approval gates, and persistence behavior.
  • Document the map workflow, including drift detection, prescriptive-to-observed conversion, rebuild behavior, and read-only checks.
  • Document the greenfield start pipeline, stage dependencies, readback reconciliation, and build approval boundary.
  • Document the feature workflow, spec and plan gates, checksum invalidation, recursive review loop, and knowledge absorption.
  • Describe shared stage-state, changelog, crash-recovery, safe-stopping, and decision-challenge mechanics using tables and Mermaid diagrams.
docs/flows.md
Expose the new workflow guide from the existing documentation entry points.
  • Link the flow guide from the README.
  • Add a cross-reference from the command reference's entry-point section.
README.md
docs/commands.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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.

1 participant