-
Contributor Guide — For new contributors (assumes Python/JS). Progressive depth:
- Part I: Language/framework/technology foundations with cross-language comparisons
- Part II: This codebase's architecture and domain model
- Part III: Dev setup, testing, codebase navigation, contributing
- Appendices: 40+ term glossary, key file reference
-
Staff Engineer Guide — For staff/principal ICs. Dense, opinionated. Includes:
- The ONE core architectural insight with pseudocode in a different language
- System architecture Mermaid diagram, domain model ER diagram
- Design tradeoffs, decision log, dependency rationale, "where to go deep" reading order
-
Executive Guide — For VP/director-level leaders. NO code snippets. Includes:
- Capability map, risk assessment, technology investment thesis
- Cost/scaling model, dependency map, actionable recommendations
-
Product Manager Guide — For PMs. ZERO engineering jargon. Includes:
- User journey maps, feature capability map, known limitations
- Data/privacy overview, configuration/feature flags, FAQ