Skip to content

docs: a single-page project flowchart - #71

Open
CodexManvik wants to merge 1 commit into
masterfrom
docs/project-flowchart
Open

CodexManvik wants to merge 1 commit into
masterfrom
docs/project-flowchart

Conversation

@CodexManvik

Copy link
Copy Markdown
Owner

The judge's review of the capstone deck was that it covers the topics in detail
but takes too long to get through, and asked for a pitch that fits a 10 minute
window. One page that carries the whole product answers that better than any
amount of trimming, so this adds a sixth diagram.

Five steps along a spine, a decision diamond under each, and every exit the
system can take:

Alert storm -> Correlate -> Diagnose -> Gate -> Execute and verify
                   |            |         |            |
              Suppressed   Escalated  No action   Closed / Rolled back

The point the picture makes is that three of the five exits are the system
declining to touch production.

Notes

The geometry gate earned its keep again. The first cut routed the rollback
branch straight through the runbook fits? diamond:

decide:runbook fits? overlaps label:no by 27x17px

No amount of reading the generator would have shown that. Fixed by stacking the
two recovered? outcomes and routing the rollback down a gutter to the left of
the column.

What is in here

  • scripts/make-diagrams.mjs: a diamond() primitive that registers its
    bounding box with the gate, and projectFlow()
  • docs/diagrams/06-project-flowchart.{dark,light}.svg
  • README and index updated, including the new gate catch

🤖 Generated with Claude Code

The judge's note on the deck was that it covers a lot and takes too long to
get through, and asked for a 10-minute pitch. One page that carries the whole
product does more for that than any amount of trimming, so this adds a sixth
diagram: five steps along a spine, a decision diamond under each, and every
exit the system can take.

The point the picture makes is that three of the five exits are the system
declining to touch production.

The geometry gate earned its keep again: the first cut routed the rollback
branch straight through the "runbook fits?" diamond, which no amount of
looking at the code would have shown.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 17, 2026 17:22
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: c5c8a19d-ca0b-45a4-acf1-d06fa0960ec1


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

2 participants