Add ARCHITECTURE.md guide for contributors and agents#67
Open
bhairaav wants to merge 1 commit into
Open
Conversation
Adds a top-level ARCHITECTURE.md following matklad's convention: bird's-eye view, code map by module, cross-cutting invariants, end-to-end data flow, and an explicit "notes for agents" section that codifies the harness-friendly patterns already in the repo (single facade, sibling-mirroring, build+example as the dev loop). README links out to it.
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
Adds a comprehensive
ARCHITECTURE.mddocument that serves as a bird's-eye map of the OpenPlans codebase for both human contributors and coding agents. The document covers:src/packages/openplans-core/,src/packages/openplans-three/, and top-level utilitiesAlso updates
README.mdto reference the new architecture guide.Verification
Docs And Examples
Updated
README.mdto link to the newARCHITECTURE.mdguide in the "Architecture" section, directing readers to the full bird's-eye map for module boundaries, invariants, and data flow details.Reviewer Notes
This is a documentation-only change. The guide is written for two audiences:
The invariants section (9 rules) is normative and should be treated as the source of truth for what is and is not allowed in the codebase. The data flow walkthrough uses a wall as the canonical example to trace through all layers.
Checklist
dist/orexamples/dist/https://claude.ai/code/session_011FQw5uuvs6XonjEHp9LCgL