docs(repo): overhaul README, CLAUDE.md, architecture and findings (#357) - #358
Merged
Merged
Conversation
Rewrite the README, release notes template, VERIFICATION checklist and the architecture chapters to the house style; trim CLAUDE.md to agent rules with pointers into docs/architecture. Delete closed and internal docs, all plans and unreferenced specs (kept specs move to docs/specs as shipped), chapter 10 and light-mode design images. Rename WOBBLE-CAPTURE to NATIVE-MAGNIFIER-STOMP, add status blocks to findings files, stop tracking .claude/settings.json and ignore docs/superpowers and .claude/worktrees. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KPUNAWcwghXdHCApcKKjSG
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.
Closes #357. Docs half of the approved docs plan; written as if the code PR (magnify engine retired, releases only in this repo) has landed.
Rewritten
docs/architecture/08-config-profiles.md#key-reference..github/release-notes.md(placeholders kept),docs/VERIFICATION.md(release smoke checklist),installer/README.md,tools/testenv/README.md(full file table, pwsh), THIRD-PARTY-NOTICES (Svelte 5).Factual fixes: StripUiOnlyKeys strips 4 keys; IsGlobalProfileKey covers the 5 tray keys;
modelvalues; seven settings groups with inline advanced rows (showAdvanced); 12 Playwright specs andwindow.__msgs; MPO walls keyed to sampling mode (nearest = always);txSamplingModedefault 0; cursor grows with zoom (#253);spriteBand16field verdict negative; Export diagnostics only in Settings; release flow in this repo; alpha channel documented in chapter 11.Deleted: KNOWN-ISSUES, ROADMAP, PERFORMANCE-FINDINGS, both PERFORMANCE-AUDIT files, performance-audit-request, PERF-SETTINGS-STARTUP, FALSE-POSITIVE-APPEALS (tree only, no history rewrite), chapter 10, all 38 plans, unreferenced specs,
*-light.pngdesign images and the duplicatec-grey.jpg(the design HTMLs now loadui/public/c-grey.jpg). The 10 kept specs moved todocs/specs/with "Status: shipped"..claude/settings.json is now untracked and gitignored. Before pulling this into the main checkout, copy it to
.claude/settings.local.json, or git deletes it there.For the code PR (comment paths and names, not edited here):
docs/superpowers/specs/->docs/specs/:src/config.h:69,src/profiles.h:3,src/tray_app/flyout_model.h:6,src/tray_app/flyout_tools.h:5,src/tray_app/tray_app.h:5,src/tray_host.h:4,src/tray_items.h:4,ui/src/tray/trayModel.js:4;src/mouse_ballistics.h:12should cite the issue instead.docs/WOBBLE-CAPTURE-2026-08-21.md->docs/NATIVE-MAGNIFIER-STOMP.md:src/config.h:268,src/transform_model.cpp:721.ui/src/shell/Banner.svelte:7cites the deleted PERF-SETTINGS-STARTUP file; replace with an inline comment.src/,ui/src/,ui/tools/,tools/and.github/workflows/release.yml; list them withgit grep -nw Max -- src ui/src ui/tools tools .github(ignoreMax zoomand[math]::Max).Tests:
build.bat test555/555 passed;build.batandbuild.bat configbuild. Noui/changes, so Playwright was not run. Link check over all non-spec Markdown: 0 broken links or anchors; no U+2014.Not verified by hand: the README's DRM line (Auto shows protected video through the transform engine) follows
engine_pick.h; confirm with a protected stream before relying on it.🤖 Generated with Claude Code
https://claude.ai/code/session_01KPUNAWcwghXdHCApcKKjSG