Refresh project docs against the current codebase for v1#37
Merged
Conversation
CONTRIBUTING.md described gui/_legacy.py (~6,200 LoC) and cli/_legacy.py (~2,200 LoC) as holding the bulk of the implementation; the decomposition finished long ago and the relationship has inverted — gui/compat.py (47 lines) and cli/_legacy.py (124 lines) are thin re-export shims. The section now says so and forbids new code there. Also corrected en masse: - docs/cli.md: twelve shipped commands were missing from the table (facet-level, tv-denoise, edge, rotate*/flip*, periodicity, grains, diag-z). - docs/review_status.md: dated 2026-06-04; now records the 2026-06 adversarial review campaign (PRs #20-#36) and lists gui.md. - docs/core_derisk_plan.md: marked completed, kept as a design record. - docs/roi_manual_test_checklist.md: dropped the stale "Phase 4c / matplotlib/QScrollArea" framing; fixed the tool-shortcut line (G = polygon, P = point; the doc claimed P polygon / T point). - docs/notes/roi-display-notes.md: flagged as point-in-time notes. All architecture claims spot-verified against the code; relative links checked. createc_dat_reader.md, gui.md, and tests/README.md were already accurate. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Sweep of every contributor/reference doc, verifying each claim against the code before rewriting — part of tidying the docs so prospective v1 users see the project as it actually is.
Stale content fixed
gui/_legacy.py(~6,200 LoC) andcli/_legacy.py(~2,200 LoC) as monoliths with the submodules as thin re-exports. The truth has fully inverted:gui/compat.pyis a 47-line shim,cli/_legacy.pya 124-line shim, and the real code lives in the canonical submodules (~42.7k LoC undergui/). Replaced with a "Compatibility shims" section that forbids adding new code to the shims. (Other claims — pre-commit hooks, pyflakes-only ruff, the 3.11/3.12 CI matrix — verified still true and left alone.)facet-level,tv-denoise,edge,rotate/rotate-90/180/270,flip-h/flip-v,periodicity,grains,diag-z. Descriptions taken from the parser's own help strings.gui.mdto the kept-docs list.Scanlazy imports and thestate.pydispatcher must not be "tidied").P= polygon /T= point, but the viewer mapsG= polygon,P= point.Verified, no change needed
docs/createc_dat_reader.md,docs/gui.md,tests/README.md,README.md(refreshed in #35/#36). All relative links across the doc set checked programmatically — zero broken.🤖 Generated with Claude Code