Architecture Decision Records (ADR)
Short, focused records of why we made key architectural decisions.
ADRs complement the existing guides and domain docs:
- Guides & domain docs → how things work and how to use them
- ADRs → why we chose this approach over alternatives
Current ADRs
- ADR 0001: Modular monolith architecture
- ADR 0002: Polymorphic media with unified collection names
- ADR 0003: API documentation & OpenAPI strategy
- ADR 0004: Authentication strategy (session, Sanctum, magic links)
- ADR 0005: Search architecture (PostGIS + Typesense)
- ADR 0006: Low-friction account creation from enquiries
When to add a new ADR
Create or update an ADR when you:
- Introduce a non-trivial architectural change
- Make a decision that will be hard to reverse later
- Need to capture trade-offs or rejected alternatives
Keep ADRs short:
- 1–2 paragraphs of context
- A clear decision statement
- Key consequences (good and bad)
- Links to relevant guides/domains