docs(adr): ADR framework, registers, and CI gate (closes #4)#165
Merged
Conversation
Adopt numbered, immutable Architecture Decision Records (Context / Decision / Rejected Alternatives / Consequences), one per [DECISION] issue, citing the claim id that settled it. ADR-0001 ratifies the process and the ranked-tenet conflict order (Compatible > Efficient > Simple > Scalable > AI-Driven). Adds INDEX/OPEN/QUESTIONS registers and an offline, deterministic check-adr-index.sh wired into the docs workflow. Closes #4 Signed-off-by: Zeke <ezequiel.lares@outlook.com>
2 tasks
- check-adr-index.sh: line-anchor section-heading match (was substring), drop the bare-number INDEX fallback (require the (NNNN-title.md) link), tolerate a trailing comment on the Status line. - OPEN.md: define the critical-path column as 'gates other decisions' (#4 rule 4), distinct from the thin-slice critical-path label; fix #37 milestone M1 -> M0. - README: link #166 for the deferred closed-issue->ADR online check. refs #4, refs #166 Signed-off-by: Zeke <ezequiel.lares@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Establishes the Architecture Decision Record framework that every later
[DECISION]PR depends on.What
README.mdrules.INDEX.md,OPEN.md(open decisions + critical-path flags),QUESTIONS.md(research-question map).scripts/ci/check-adr-index.sh: offline gate (4 sections + Status, claim-id citations exist in claims.yaml, supersession links resolve, every record listed in INDEX), wired into the docs workflow.Review focus
Closes #4. Part of the M0: Vision and Scope milestone.