Architectural Decision Records

This directory captures significant architectural decisions made in the Owlat project. Each record explains the context, the decision, and the trade-offs...

This directory captures significant architectural decisions made in the Owlat project. Each record explains the context, the decision, and the trade-offs involved.

Format

We use a lightweight ADR format:

# ADR-NNN: Title
- Status: Accepted | Superseded | Deprecated
- Date: YYYY-MM-DD
- Context: What prompted this decision
- Decision: What was decided
- Consequences: Trade-offs, what this enables/prevents

Decisions

ADRTitleStatus
001Custom email renderer over MJMLAccepted
002Convex as backendAccepted
003Notion-like email builderAccepted
004Monorepo with Bun workspacesAccepted

Adding a New ADR

  1. Create a new file: NNN-short-title.md (use the next available number)
  2. Follow the format above
  3. Add a row to the table in this index
  4. Submit with your PR