docs(adr): compress to 10 records in the domain-modeling format - #128
Merged
Merged
Conversation
Drop 0001, 0010, 0011, 0017; merge 0009 into 0003, 0014 into 0006, 0008 into 0007; record the #118 manual-control decline in 0005. Each record is now title plus one paragraph, without the Decision / rationale / Revisit-trigger sections. Numbers stay stable, with gaps.
This was referenced Sep 19, 2026
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
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.
Rewrites
docs/adr/from 17 records (~4,800 words) to 10 (~970 words). Each record is now a title plus one paragraph, in the domain-modeling skill's native shape; theDecision/ rationale /Revisit triggersections are gone. Where a revisit trigger was the real boundary of the decision (0013's "second backend", 0016's "second protocol") it is folded into the paragraph; the speculative ones are dropped.Evaluation
Each record was tested against the skill's three criteria: hard to reverse, surprising without context, the result of a real trade-off.
docs/decoders.md, which says single-pass is a performance choice for the built-ins and not a protocol obligation. The docs are right.*_with_response+ 0008 no pagination helpersend_with_response". Same surface.decideraises_RetryPolicyclass docstring already states the chaining reason.__reduce__tests/test_errors.pynow carries the reason itself._internal/bullet inAGENTS.md.Mechanics
tests/test_client_parity.py, the directory link indocs/index.md, and the closing comment onCircuitBreaker.force_open()/force_closed()— manual control #118 (edited to the new paths). No page, test, or sibling repo links a dropped or old number.tests/test_client_parity.pycited 0009 and 0003 in the shortdocs/adr/NNNNform, whichtests/test_adr_citations.pydoes not match. Both now use the full path so a rename is caught.pytest(817 passed),ruff,eof-fixer, andlychee --offlineover the touched Markdown.Closes the ADR follow-up from #118.