feat: add README demo GIF and Playwright recording script#12
Merged
Conversation
- Add scripts/record-demo.mjs: Playwright recordVideo → ffmpeg → optimised GIF - Add npm script demo:record (default output: docs/demo.gif) - Update docs.yml CI to install ffmpeg + Playwright, record fresh GIF on every docs deploy - Embed docs/demo.gif in README under 'How it looks' - Set overview.position: last so viewer starts at step 01 (All at end) - Rebuild example HTMLs from updated story YAML - Add playwright devDependency
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.
What
scripts/record-demo.mjs: uses PlaywrightrecordVideoto capture a full walkthrough of the vLLM example, then converts to an optimised GIF via ffmpegoverview.position: lastso the viewer starts at step 01 ("All" appears at the end of the nav row)docs.yml) to install ffmpeg + Playwright, record a fresh GIF on every deploy, and publish it to the docs site at/demo.gifdemo:recordnpm script for local regenerationWhy
The README had no visual preview. A GIF is the best way to show the zoom/pan animations and step navigation that make up the core DiaScope experience.
GIF details
palettegen/paletteuse, bayer dithering)CI notes
docs.ymlnow: installs ffmpeg → installs Playwright Chromium → runsdemo:record --out docs-site/public/demo.gif→ builds docs. The GIF in the repo (docs/demo.gif) provides the README preview; the CI-generated one at/demo.gifon the docs site stays fresh automatically.