tranquil
Docs

Architecture Decision Records

This folder contains Architecture Decision Records (ADRs) for tranquil.

Format

Each ADR is a markdown file with YAML frontmatter. Template:

---
type: ADR
id: "0001"
title: "Short decision title"
status: proposed        # proposed | active | superseded | retired
date: YYYY-MM-DD
superseded_by: "0007"  # only if status: superseded
---

# ADR-0001: Short decision title

**Status:** Active · **Date:** YYYY-MM-DD

## References
*(optional)* Related docs — delivery notes, guides, other ADRs. Put these **at the top**, not the
bottom, so a reader can jump straight to the supporting material. Omit the section if there are none.
- [Delivery Notes](../../foo-notes/)
- [Some Guide](../../some-guide/)

## Context
What situation led to this decision? What forces and constraints are at play?

## Decision
**What was decided.** State it clearly in one or two sentences — bold so it stands out.

## Options considered
- **Option A** (chosen): brief description — pros / cons
- **Option B**: brief description — pros / cons

## Consequences
What becomes easier or harder as a result?
What would trigger re-evaluation of this decision?

## Advice
*(optional)* Input received before making this decision.
Omit if the decision was made unilaterally with no external input.

Status lifecycle

proposed → active → superseded
                ↘ retired      (decision no longer relevant, not replaced)

Rules

  • One decision per file
  • Files named NNNN-short-title.md (monotonic numbering)
  • Reference links (delivery notes, guides, related ADRs) go in a ## References section at the top, immediately under the status/date line — not at the bottom
  • Once active, never edit — supersede instead
  • When superseded: update status: superseded and add superseded_by: "NNNN"