| name | architecture-docs |
| version | 1.0.0 |
| description | Write ARCHITECTURE.md files for hyperfrontend libraries. Use when creating architecture documentation, documenting design decisions, adding system overview diagrams, or explaining module composition and data flow. |
Architecture Docs
Create ARCHITECTURE.md at libs/<name>/ARCHITECTURE.md.
Explains how a system is designed—not usage (that's README.md).
Required Sections
- System Overview — Mermaid flowchart + brief prose
- Design Principles — Numbered list with ✅/❌ code examples
- Module Composition — Table mapping modules to responsibilities
- Data Flow — Sequence diagram for key operations
- Core Interfaces — Primary TypeScript contracts
- Links — Point to README.md and src/README.md
Checklist