Skip to content

docs: add ARCHITECTURE.md — technical decision rationale for engineers - #128

Merged
CodeNinjaSarthak merged 1 commit into
mainfrom
docs/architecture-md
May 5, 2026
Merged

docs: add ARCHITECTURE.md — technical decision rationale for engineers#128
CodeNinjaSarthak merged 1 commit into
mainfrom
docs/architecture-md

Conversation

@CodeNinjaSarthak

Copy link
Copy Markdown
Owner

Summary

  • Adds ARCHITECTURE.md at 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 warnings
  • Three Mermaid diagrams: session lifecycle state machine, refinement execution flow, cost tracking flow — each placed before the prose that references it
  • Satisfies the architecture diagram deliverable from README final pass: demo GIF, architecture diagram, what-I-didn't-build section #72

What 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

  • Render ARCHITECTURE.md in GitHub preview — confirm all three Mermaid diagrams render without errors
  • Run python scripts/check_mermaid.py ARCHITECTURE.md locally to validate diagram syntax
  • Grep for parentheses in Mermaid blocks: awk '/\``mermaid/,/```/' ARCHITECTURE.md | grep '('` — should return no matches

Closes #72

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
CodeNinjaSarthak merged commit 914cdff into main May 5, 2026
2 checks passed
@CodeNinjaSarthak
CodeNinjaSarthak deleted the docs/architecture-md branch May 5, 2026 05:35
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
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.

README final pass: demo GIF, architecture diagram, what-I-didn't-build section

1 participant