ADR 0001: Git-backed Markdown and versioned interface specifications¶
- Status: Accepted
- Date: 2026-08-06
Context¶
Engineering documentation and interface references must remain reviewable and traceable to service changes without maintaining duplicate endpoint and message definitions.
Decision¶
Markdown in this private repository is the documentation source of truth. OpenAPI and AsyncAPI specifications are committed beside the API and WebSocket material, linked from the MkDocs site, and treated as authoritative for endpoint and payload reference.
Consequences¶
Integration prose documents flows and semantics, not copied schemas. Future renderers must consume these committed specifications directly.