Skip to content

docs: demo media (webm + screenshots) for the README - #14

Merged
seanpk merged 2 commits into
masterfrom
docs/demo-media
Jun 16, 2026
Merged

seanpk merged 2 commits into
masterfrom
docs/demo-media

Conversation

@seanpk

@seanpk seanpk commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Adds a "see it without clicking" demo to the README, per the plan we discussed.

  • scripts/demo.mjs (npm run demo) — drives the overlay through a scripted review against the static-site fixture and records docs/media/demo.webm plus three stills. Re-running overwrites in place, so the README never needs editing. It's a generator, not a test (excluded from the Playwright testDir), and lints under Node (locator APIs only; the on-screen cursor dot is injected as a script string).
  • README — a three-beat visual story (select → comment → queue) with a ▶ Watch the demo link to the committed webm. Static images render inline on GitHub and npm; the webm plays via GitHub's file viewer when clicked.

Notes:

  • Media is committed for rendering but not added to files, so the npm tarball stays small (39 files, no media). README uses absolute raw.githubusercontent.com/...@master URLs (matching the logo), so images resolve once this is on master.
  • Why webm + a click-to-watch link instead of an inline GIF: a committed webm can't autoplay inline on GitHub (needs an attachment URL) and npm doesn't render <video> at all — so the static screenshots carry the inline story and the webm is the optional full-motion watch. A GIF can be added later if we want inline motion.

🤖 Generated with Claude Code

seanpk and others added 2 commits June 16, 2026 19:40
Show the tool in action in the README without requiring a click:

- scripts/demo.mjs (+ `npm run demo`): drives the overlay through a
  scripted review against the static-site fixture and records
  docs/media/demo.webm plus three stills (select / comment / queue).
  Not a test — excluded from the Playwright testDir; lints under Node
  (Playwright locator APIs only; the on-screen cursor is injected as a
  script string).
- README: a three-beat visual story (select -> comment -> queue) with a
  "Watch the demo" link to the committed webm.

Media is committed for rendering but kept out of the npm tarball (not in
`files`); README uses absolute raw URLs (matching the logo) so it renders
on GitHub and npm once merged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@seanpk
seanpk merged commit 38e8466 into master Jun 16, 2026
4 checks passed
@seanpk
seanpk deleted the docs/demo-media branch June 16, 2026 23:50
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.

1 participant