Condense ADRs to a scannable one-paragraph format - #47
Draft
markwong167 wants to merge 1 commit into
Draft
markwong167 wants to merge 1 commit into
markwong167 wants to merge 1 commit into
Conversation
Full MADR sections (Context/Considered Options/Decision Outcome/ Consequences) made every ADR a multi-paragraph document, which works against the point of an ADR: letting someone quickly find and understand why a decision was made. Each ADR is now one paragraph naming the choice and why the alternatives lose, with a short consequences list only where there's a real gotcha to flag. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KAXYbGssfXr8CDy861WD5P
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
2 participants
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
Stacked on #46 — rewrites every ADR in
docs/adr.mdinto a condensed format so the doc is fast to scan:Each ADR now states the chosen option and why the alternatives lose, in one paragraph, instead of full MADR sections (Context / Considered Options / Decision Outcome / Consequences).
Draft because it depends on #46 merging first (same file, and this rewrite assumes the corrected ADR-005/ADR-011 content from that PR).
Test plan
pint/pestnot applicableGenerated by Claude Code