docs(readme): inline GIF preview + YouTube link for the full tour#49
Merged
Conversation
GitHub's README sanitizer strips <video src=...> elements whose src isn't on the user-attachments allowlist — even when the URL is a trusted github.com/.../raw or raw.githubusercontent.com path. That left the previous embed (#46, #47) rendering as just the fallback caption. Fix: switch the inline preview to an animated GIF (<img>), which github.com's sanitizer trusts from any raw/relative URL and which auto-plays / auto-loops on scroll-into-view in every markdown renderer (web, GitHub mobile, IDE previews). Keep the YouTube link right under it for viewers who want audio + full quality. Files - Add docs/forgechat-overview.gif — 14 MB, 640×310, 12 fps, palette- optimized with bayer dither. Visually equivalent to the MP4 for a screen-recording tour. - Remove docs/forgechat-overview.mp4 from the working tree. The same MP4 stays attached to the v1.0.0 release for direct download. Git history still holds the blob (added in #47), so this only shrinks the working-tree size for clones from main forward. - README block becomes <img> wrapped in <a href=YouTube>, with a caption below pointing at YouTube for the full audio version. Signed-off-by: KingArthur000 <sathyaprakashelango@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
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.
Why
The previous video PRs (#46, #47) shipped a
<video src=...>element, but GitHub's README sanitizer strips<video>elements whosesrcisn't on its allowlist — and onlyuser-attachments/assets/*URLs are on that list. Release-asset URLs andraw.githubusercontent.comURLs both get scrubbed. Net result: visitors saw only the fallback caption, no video element.What changed
Switch the inline preview from
<video>(sanitized away) to an animated<img>GIF — github.com trusts<img>from any raw/relative URL.Wrapping the GIF in
<a href="https://youtu.be/...">means clicking the GIF opens the full audio version on YouTube — best of both worlds.Files
docs/forgechat-overview.gif— 14 MB, 640×310, 12 fps, palette-optimized via ffmpeg's two-pass palettegen + bayer dither. Visually equivalent to the MP4 for a screen-recording tour.docs/forgechat-overview.mp4from the working tree. The same MP4 stays attached to the v1.0.0 release for direct download. (Git history still holds the blob; this only shrinks the working-tree size for new clones.)Test plan