From 789931d90f2578835f62851d7a581d3f610bc833 Mon Sep 17 00:00:00 2001 From: Elijah Duffy Date: Fri, 23 Oct 2026 14:57:21 -0700 Subject: [PATCH] docs: correct two statements in the format ADR Co-Authored-By: Claude Sonnet 5.5 --- ...dopt-a-checked-format-for-adrs-and-implementation-plans.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adr/20261023T214738672Z-adopt-a-checked-format-for-adrs-and-implementation-plans.md b/docs/adr/20261023T214738672Z-adopt-a-checked-format-for-adrs-and-implementation-plans.md index c7cc81c..7a07f6f 100644 --- a/docs/adr/20261023T214738672Z-adopt-a-checked-format-for-adrs-and-implementation-plans.md +++ b/docs/adr/20261023T214738672Z-adopt-a-checked-format-for-adrs-and-implementation-plans.md @@ -40,7 +40,7 @@ We need one format that people and tools can write without surprises, that separ ## Decision Outcome -Chosen option: "Define one format and implement one shared Go CLI that creates and checks records", because it is the only option that gives a single enforced vocabulary and identity scheme while keeping the checks dependency-free. +Chosen option: "Define one format and implement one shared Go CLI that creates and checks records", because it is the only option that gives a single enforced vocabulary and identity scheme while keeping the checks free of service dependencies. The format is specified in [docs-format](/docs/docs-format.md). It uses the MADR 4 layout, with `### Consequences` under Decision Outcome made mandatory, and adds the parts MADR leaves open: timestamp-based permanent IDs in filenames, a fixed frontmatter schema, a separate `implementation` field, reciprocal supersession, durable repo-root references, and a plan record with its own lifecycle. The CLI, `docs`, offers `docs new adr|plan` and `docs check`. @@ -73,7 +73,7 @@ The format is specified in [docs-format](/docs/docs-format.md). It uses the MADR ### Define one format and implement one shared Go CLI that creates and checks records * Good, because one specification and one implementation can be tested thoroughly and installed with `go install`. -* Good, because the same binary creates records, so new files start valid. +* Good, because the same binary creates records, so new files start with the required structure. * Bad, because we commit to maintaining a small public tool and a specification. ## More Information