Skip to content

docs: bring template ADRs to living-schema conformance#35

Merged
NWarila merged 1 commit into
mainfrom
pt-m2-adr-conformance
Jun 3, 2026
Merged

docs: bring template ADRs to living-schema conformance#35
NWarila merged 1 commit into
mainfrom
pt-m2-adr-conformance

Conversation

@NWarila

@NWarila NWarila commented Jun 3, 2026

Copy link
Copy Markdown
Owner

PT-M2 - ADR conformance (reformat, resolve dangling refs, write the missing)

Brings docs/decision-records/template/ into full living-ADR-schema conformance and closes the PT-M1 docs-layout gap.

Changes

  • Reformat ADR-0001 and ADR-0002 to the 13-field living metadata table + Compliance Notes + Changelog (decision content preserved verbatim).
  • Resolve dangling references: ADR-0002 -> org ADR-0004 (Renovate) as a tier-qualified cross-tier link; ADR-0001 -> new template ADR-0003.
  • Add ADR-0003 (Python minimum version floor, 3.11) and ADR-0004 (Python package layout and app anatomy; generic, no framework/domain).
  • Relocate the docs index out of the docs/ root (disallowed by the docs-layout standard) to docs/explanation/documentation-map.md; remove docs/README.md.

Gates (all green)

  • check_adr_schema - 14 ADRs, 4 changed, full living-shape
  • check_docs_layout and check_ai_residue
  • scripts/qa.py - 6/6 (lint, package, security, spelling, tests, types)
  • Zero dangling refs; scope limited to the six intended paths; org/ mirror byte-untouched.

Reformat docs/decision-records/template ADRs to the full living-ADR
schema and close the PT-M1 docs-layout gap.

- Reformat ADR-0001 and ADR-0002 to the 13-field living metadata table
  with Compliance Notes and Changelog sections; decision content preserved.
- Resolve dangling references: ADR-0002 -> org ADR-0004 (Renovate,
  tier-qualified cross-tier link); ADR-0001 -> new template ADR-0003.
- Add ADR-0003 (Python minimum version floor, 3.11) and ADR-0004
  (Python package layout and app anatomy).
- Relocate the docs index out of docs/ root (disallowed by the docs-layout
  standard) to docs/explanation/documentation-map.md; remove docs/README.md.

check_adr_schema, check_docs_layout, check_ai_residue, and scripts/qa.py all pass.
@NWarila NWarila merged commit 12b43b4 into main Jun 3, 2026
13 checks passed
@NWarila NWarila deleted the pt-m2-adr-conformance branch June 3, 2026 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant