docs: switch README demo to a VHS recording (fixes truncation)#20
Merged
Conversation
The README demo was a 720px hand-authored SMIL SVG with fabricated output —
narrow enough that real output lines clipped ('truncated'). Switch to VHS
(charmbracelet/vhs): docs/demo.tape records REAL pdcli at 1200px/16px into a
crisp, brand-themed animated WebP, regenerable via 'npm run docs:demo'.
- add docs/demo.tape (read-only aggregate commands; no PII; repeatable)
- docs:demo now runs 'vhs docs/demo.tape' → docs/demo.webp
- README <img> → docs/demo.webp; CONTRIBUTING documents the vhs requirement
- retire scripts/gen-demo.mjs, its test, and docs/demo.svg
NOTE: docs/demo.webp must be generated (vhs needed; not in CI). Run
'npm run docs:demo' against a sandbox profile and commit the webp before merge.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Homebrew's ffmpeg ships without libwebp, so 'Output docs/demo.webp' fails with 'Encoder not found'. GIF uses ffmpeg's built-in encoder, renders in a GitHub <img>, and the recording itself was already correct.
docs:demo is back to a clean 'vhs docs/demo.tape' producing docs/demo.webp. Requires an ffmpeg built with libwebp (homebrew-ffmpeg tap --with-libwebp); documented in the tape header and CONTRIBUTING.
The account has 2 pipelines, so 'pipeline health' / 'metrics coverage' errored without --pipeline. Use --pipeline 1 and swap deal-summary/coverage (which surfaced absurd sandbox values) for funnel + field-list — value-independent, clean output that showcases the custom-field hash-key resolution.
… a short upsert - Hide/clear/Show between scenes so each starts at the top (readability; no bleed, tall tables not caught mid-scroll). - Replace 'field list deal' (30+ rows, overflowed the frame) with a one-line 'person upsert --dry-run' that showcases idempotent match-or-create.
…ings - Scene 3 → 'pdcli audit': a fixed ~11-row check table (name/severity/count), bounded and PII-free (no --verbose), showing the value-add differentiator — 'your CRM, checked' — to close the see → act → improve arc. - scripts/seed-demo.sh builds a clean 'pdcli demo' pipeline (4 stages, 10 deals with sane €values, a stale deal + duplicate person for audit findings) via the host-locked api passthrough, then rewrites --pipeline in docs/demo.tape. So the real recording renders as polished as the old fabricated frames, reproducibly.
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
2 participants
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 demo was a 720px hand-built SMIL SVG with fabricated output — too narrow, so real output lines clipped (the 'truncated' look) and it was flat/synthetic.
Switches to VHS:
docs/demo.taperecords real pdcli at 1200px / 16px into a crisp, brand-themed animated WebP (smaller + sharper than GIF, renders on GitHub). Regenerable withnpm run docs:demo.docs/demo.tape— read-only aggregate commands (pipeline health, deal summary, coverage); no PII; repeatabledocs:demo→vhs docs/demo.tape→docs/demo.webp<img>→docs/demo.webp; CONTRIBUTING documents the vhs requirementscripts/gen-demo.mjs, its test, anddocs/demo.svgdocs/demo.webpisn't generated (vhs needs a TTY + a binary, not available in CI). To finish:Then merge. Until the webp is committed, the README image will 404.