docs(readme): embed preview gifs in Problem and Benchmarks sections#312
Open
sebastianbreguel wants to merge 7 commits intomksglu:mainfrom
Open
docs(readme): embed preview gifs in Problem and Benchmarks sections#312sebastianbreguel wants to merge 7 commits intomksglu:mainfrom
sebastianbreguel wants to merge 7 commits intomksglu:mainfrom
Conversation
- Add `docs/assets/preview-text-example.gif` — split-screen nginx log (raw 130.4 KB) vs ctx_execute summary (0.4 KB) - Add `docs/assets/preview-benchmarks.gif` — animated bars for the 6 headline benchmark rows (937.8 KB → 80.1 KB) - Wire both into README: text-example under "The Problem", benchmarks under "Benchmarks"
Previous gif had inline bar labels that overlapped the right-side value columns, making numbers hard to read. Regenerated with labels fully separated into their own columns (Raw / Context / Saved). - Add `scripts/benchmarks-video/` — reproducible renderer (HTML + CSS animation driven by Playwright, ffmpeg post-processing) - Replace `docs/assets/preview-benchmarks.gif` (clean layout, 1.4 MB, 9s animation, 1280x720) - Also persist `docs/assets/preview-benchmarks.mp4` as the high-quality source for future regens
Re-encoded from the 1920x1080 source mp4 using the same HQ palette pipeline as preview-benchmarks (1280 wide, 15fps, stats_mode=full, bayer dither scale 5, rectangle diff). Text is visibly crisper. - Replace `docs/assets/preview-text-example.gif` (18 MB, 1280x720) - Also persist `docs/assets/preview-text-example.mp4` (3 MB, crf 20) as the high-quality source for future regens
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.
Summary
docs/assets/preview-text-example.gifunder The Problem — split-screen nginx log (130.4 KB raw) vsctx_executesummary (0.4 KB). Shows the flooding problem and the fix side by side in ~20s.docs/assets/preview-benchmarks.gifunder Benchmarks — animated bars for the 6 headline benchmark rows (937.8 KB → 80.1 KB session total). Makes the table scannable at a glance.Both are referenced from the existing sections of
README.md. No copy changes, no new sections — just visuals to support claims already in the README.Files
README.md(+8 lines, two<p align="center"><img .../></p>blocks)docs/assets/preview-text-example.gif(11.3 MB, 1100w @ 12fps, HQ palette)docs/assets/preview-benchmarks.gif(1.0 MB, 1280w @ 15fps, HQ palette)Test plan
README.mdon GitHub, verify both gifs load under their sectionswidth="960"with natural shrink)