Repository navigation
Rewrite the README as the capture procedure and its proof - #2
Merged
Merged
Conversation
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>
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
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.
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
safeShot()as the only path that writes a PNG.waitForIsc()does not throw when a post-condition never appears. The shipped modules do not callrunBeat().scripts/smoke-test.jsand.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 inlib/nav.js, withbench-results.jsongitignored.modules/login.jsandmodules/admin.jsemit, andnav.gotois not a function. The REPL example now callsiscNav.navigatePath().Noted in the doc, not fixed here
modules/home.jspasses a toolbar crop as{ x, y, width, height }.lib/redact.jsreadsleftandtop, so that crop arithmetic isNaNand the bounds check does not raiseRedactionError. The README tells the writer not to treathome-toolbar.pngas a figure the module produces.