docs: compress demo video (100MB → 6MB)#72
Open
827652549 wants to merge 10 commits into
Open
Conversation
Replace the uncompressed MOV attachment with a compressed MP4 committed directly to the repository. Why commit to repo instead of GitHub CDN attachment: - GitHub user-attachments URLs (uploaded via issue/PR drag-drop) have known rendering issues in markdown — the video loads fine when opened directly but fails to embed in README or PR comments - Uploading to a stable CDN (e.g. GitHub Releases assets) requires write access to the upstream repo, which external contributors don't have - At 6MB the file is small enough to commit without meaningfully impacting clone size Changes to the video: - Convert MOV to MP4 with faststart flag (moov atom at file start, enables playback before full download) - Strip empty audio track (original had no audio data) - Result: ~100MB → 6MB with no visible quality loss
Author
|
Hey @joshuayoes 👋 — could you check whether the demo video in the README renders correctly on your end? We noticed that GitHub If you see the same issue, I can switch to committing |
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.
The demo video in the README is a ~100MB uncompressed MOV file, which causes slow page loads for everyone who visits the repo.
Changes
-movflags faststart(moov atom at file start, enables playback before full download)Note on video hosting
The compressed video is referenced via a GitHub
user-attachmentsURL — the same approach as the original. If the embedded player appears flaky on your end, I can switch to committing the file directly to the repo (demo.mp4, 6MB). Left a comment below with more detail.