Skip to content

Rewrite the README as the capture procedure and its proof - #2

Merged
pinklightultra merged 1 commit into
mainfrom
cursor/readme-tw-portfolio-3ffc
Oct 28, 2026
Merged

pinklightultra merged 1 commit into
mainfrom
cursor/readme-tw-portfolio-3ffc

Conversation

@pinklightultra

Copy link
Copy Markdown
Owner

The README is now the document a writer uses to capture SmartClient UI figures, and the document a reviewer can check against the code.

What changed

  • Opens with who the kit is for (a writer producing release figures from a shared environment) and the two controls that ship on: the click guard, and safeShot() as the only path that writes a PNG.
  • Walks the three failures that look like a finished run. Each one names the file that handles it and stops at what that file actually does. Reference-stop is opt-in. waitForIsc() does not throw when a post-condition never appears. The shipped modules do not call runBeat().
  • Gives the install, capture, diff, and annotate procedures, including exit codes, where files land, and which flags change behavior.
  • Points proof at scripts/smoke-test.js and .github/workflows/ci.yml: what the smoke job runs, and the assertions in the test. The click-strategy timings stay attributed to the one run recorded in lib/nav.js, with bench-results.json gitignored.
  • Drops the terminology glossary and the sample transcript. That transcript's step counts are not what modules/login.js and modules/admin.js emit, and nav.goto is not a function. The REPL example now calls iscNav.navigatePath().

Noted in the doc, not fixed here

modules/home.js passes a toolbar crop as { x, y, width, height }. lib/redact.js reads left and top, so that crop arithmetic is NaN and the bounds check does not raise RedactionError. The README tells the writer not to treat home-toolbar.png as a figure the module produces.

Open in Web Open in Cursor 

State who the kit is for, tie each capture failure to the code that
handles it, and give a writer the install, run, diff, and annotate
steps. Point proof at the smoke-test assertions and the CI workflow.

Co-authored-by: Pinklightultra <justinsevern@gmail.com>
@pinklightultra
pinklightultra merged commit 3b7738e into main Oct 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants