Architecture¶
How BizOS is built and why. Specs say what the product does; this folder says how the system does it.
Contents¶
| Path | What |
|---|---|
STACK.md |
Tech stack, Clean Architecture (backend), Feature-Based Architecture (frontend), Dual Identity model, repository layout, and code rules |
adr/ |
Architecture Decision Records: one file per significant technical decision (ADR-0001 to ADR-0010) |
Add architecture documents here as they are written (for example system overview, multi-tenancy, data model, security), and list each one in the table above.
Conventions¶
- Write in English and keep documents tech-focused: components, data flow, boundaries, trade-offs.
- Prefer diagrams as code (Mermaid in Markdown) so they can be reviewed in diffs.
- A document describes the current state. When a decision changes it, write a new ADR and update the document in the same change.
- Use placeholders such as
<root-domain>instead of real hosts. Never put credentials, internal URLs, or customer data here.