docs: add ARCHITECTURE.md — technical decision rationale for engineers - #128
Merged
Conversation
Covers: orchestrator branching ownership, session state as Redis blob, refinement distributed-systems mechanics, cost tracking design, deliberate omissions, and known test suite warnings. Includes Mermaid diagrams for session lifecycle, refinement execution flow, and cost tracking flow. Closes #72
CodeNinjaSarthak
added a commit
that referenced
this pull request
May 5, 2026
#128) Covers: orchestrator branching ownership, session state as Redis blob, refinement distributed-systems mechanics, cost tracking design, deliberate omissions, and known test suite warnings. Includes Mermaid diagrams for session lifecycle, refinement execution flow, and cost tracking flow. Closes #72
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
ARCHITECTURE.mdat the repo root: six sections covering orchestrator branching ownership, session state design, refinement as a distributed-systems problem, cost tracking design, deliberate omissions, and known test suite warningsWhat this covers from #72
The "architecture diagram" and "what-I-didn't-build section" items are covered here. The demo GIF and any remaining README prose from #72 can land separately since this document stands alone.
Test plan
ARCHITECTURE.mdin GitHub preview — confirm all three Mermaid diagrams render without errorspython scripts/check_mermaid.py ARCHITECTURE.mdlocally to validate diagram syntaxawk '/\``mermaid/,/```/' ARCHITECTURE.md | grep '('` — should return no matchesCloses #72