docs: index ADRs and plans, wire into SUMMARY.md#66
Merged
Conversation
docs/adr/ and docs/plans/ both had several files but no index — the parent docs/README.md linked to the directories rather than to landing pages, and SUMMARY.md (mdbook nav) didn't list them at all. Adds: - docs/adr/README.md: status table for all 8 ADRs, brief notes on how they relate, and conventions for adding a new ADR. - docs/plans/README.md: status table grouped by Active / Implemented / Deferred / Exploratory, plus a reading order for the timing-stack plans. - docs/SUMMARY.md: new "Decisions & plans" section listing every ADR and plan individually, plus the OpenTimer spike. - docs/README.md: parent links now point at the new index pages. Co-developed-by: Claude Code v2.1.143 (claude-opus-4-7)
robtaylor
force-pushed
the
docs/plans-adrs-index
branch
from
35e1a01 to
89263c3
Compare
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.
Summary
docs/adr/anddocs/plans/had files but no landing pages —docs/README.mdlinked to the directories, anddocs/SUMMARY.md(mdbook nav) didn't list them at all.SUMMARY.mdlisting every ADR and plan, and updates the parentdocs/README.mdlinks to point at the new index pages.What's in each new file
docs/adr/README.md— status table for all 8 ADRs (Accepted / Approved / Proposed / Superseded), brief notes on how the timing-stack ADRs (0001/0003/0005/0006), the IR contract (0002), the private PDK track (0004) and the forward-looking pair (0007/0008) relate, plus the convention for adding a new ADR.docs/plans/README.md— status table grouped by Active / Implemented / Deferred / Exploratory, a reading order for the timing-stack plans, and the convention for adding a new plan.docs/SUMMARY.md— new "Decisions & plans" section listing every ADR and plan individually so they show up in the mdbook sidebar.docs/README.md— top-level documentation index now points at the new ADR and plans landing pages rather than the directories.No content moves; existing ADRs and plans are untouched.
Test plan
docs/adr/README.mdtable links resolve to each ADR file.docs/plans/README.mdtable links resolve to each plan file.