TypeDialog/docs/adr/README.md

22 lines
806 B
Markdown
Raw Normal View History

# Architecture Decision Records
ADRs documenting key architectural decisions and their rationale for TypeDialog.
## ADR Index
- **[ADR-001: Nickel as First-Class Form Definition Format](./adr-001-nickel-form-definition.md)** —
Nickel (`.ncl`) forms loaded via `nickel export` subprocess, replacing `ContractValidator`,
fragment lazy-loading, and `${constraint.*}` interpolation. TOML remains supported.
## Decision Format
Each ADR follows this structure:
- **Status**: Accepted, Proposed, Deprecated, Superseded
- **Context**: Problem statement and constraints
- **Decision**: The chosen approach
- **Rationale**: Numbered list of reasons
- **Consequences**: Benefits and trade-offs
- **Implementation**: Code showing how it works
- **Alternatives Considered**: Rejected options with reasoning