docs: retire ISSUES.md; fold by-design decisions into ARCHITECTURE/THEORY - #11
Merged
Conversation
…EORY Every tracked item was resolved or won't-fix, so the file held no open work. Delete it and remove the now-dangling (ISSUES Xn) cross-references that ARCHITECTURE.md and THEORY.md used as decision-record shorthand. Add the __getattr__ bare-AttributeError decision (W2) to ARCHITECTURE landmines so all three by-design calls live in the cold-start pickup doc (W1/W3 already did), and repoint the "record a decision" signposts at ARCHITECTURE/THEORY for decisions and GitHub issues for defects.
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.
Why
ISSUES.mdwas a fresh-eyes-review tracker. Every tracked item is now either resolved ([x], 12 items) or won't-fix / by-design ([~], 3 items) — nothing is open. As a released project, ongoing work belongs in GitHub issues, not a checked-in changelog. So this retires the file.What
ISSUES.md. Resolved history lives in git; the by-design rationale is already in the docs.ARCHITECTURE.md— add W2 (__getattr__raises a bareAttributeErrorfor_-prefixed names) as a landmine, so all three by-design decisions sit in the cold-start pickup doc (W1/W3 were already there). Drop theISSUES W1/W3tags; repoint the "record a decision / known issue" signpost at ARCHITECTURE/THEORY (decisions) and GitHub issues (defects).THEORY.md— strip the 10(ISSUES Xn)cross-references (the surrounding prose is already self-contained) and rewrite the "the decision record isISSUES.md" framing so that section stands on its own.Verification
git grep ISSUESreturns nothing — no dangling references remain anywhere in the tree.No GitHub issues were created: all 15 items were already closed-out, so mirroring them would have produced only pre-closed noise.