docs: add an architecture map and fix the docs that drifted from the … - #20
Merged
Merged
Conversation
…code The README described features that no longer matched the code and left out the ones added since: the viewer had no mention of Export report (Ctrl+E), the module tree was missing view_model / syntax / review / gitsource, and the add-a-rule note skipped a2l_rules, the shadow step and the beside-a-real-change test that the rule checklist actually requires. docs/architecture.md is the map that was missing entirely: why the core is stdlib-only, what each of the two diff passes decides, why the verdict lives in one function, and what the result dict guarantees downstream. CLAUDE.md stays the rules and now points at it instead of restating it. Corrected against the code rather than assumed: build.ps1 has no -Exe switch (default builds the exe, -Pyz / -PyzOnly add or isolate the zipapp), the smoke command named a script that is not in the repo, and the zipapp is ~110 KB, not the 78-80 KB three files claimed.
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.
…code
The README described features that no longer matched the code and left out the ones added since: the viewer had no mention of Export report (Ctrl+E), the module tree was missing view_model / syntax / review / gitsource, and the add-a-rule note skipped a2l_rules, the shadow step and the beside-a-real-change test that the rule checklist actually requires.
docs/architecture.md is the map that was missing entirely: why the core is stdlib-only, what each of the two diff passes decides, why the verdict lives in one function, and what the result dict guarantees downstream. CLAUDE.md stays the rules and now points at it instead of restating it.
Corrected against the code rather than assumed: build.ps1 has no -Exe switch (default builds the exe, -Pyz / -PyzOnly add or isolate the zipapp), the smoke command named a script that is not in the repo, and the zipapp is ~110 KB, not the 78-80 KB three files claimed.