Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Architecture Decision Records

This section documents significant architecture decisions made in the TeaLeaf project. Each record captures the context, decision, and consequences of a choice that affects the project’s design or implementation.

ADR Index

ADRTitleStatusDate
ADR-0001Use IndexMap for Insertion Order PreservationAccepted2026-02-05
ADR-0002Fuzzing Architecture and StrategyAccepted2026-02-06
ADR-0003Maximum Nesting Depth Limit (256)Accepted2026-02-06
ADR-0004ZLIB Compression for Binary FormatAccepted2026-02-06

What is an ADR?

An Architecture Decision Record (ADR) is a short document that captures an important architectural decision along with its context and consequences. ADRs help future contributors understand why certain design choices were made, not just what was built.

ADR Lifecycle

Each ADR has one of the following statuses:

  • Proposed — Under discussion, not yet implemented
  • Accepted — Approved and implemented (or in progress)
  • Superseded — Replaced by a newer ADR (linked in the record)
  • Deprecated — No longer applicable due to project changes