chore(docs): migrate docs/images/ media to static.heygen.ai CDN#301
Merged
jrusso1020 merged 1 commit intomainfrom Apr 17, 2026
Merged
chore(docs): migrate docs/images/ media to static.heygen.ai CDN#301jrusso1020 merged 1 commit intomainfrom
jrusso1020 merged 1 commit intomainfrom
Conversation
Move all preview mp4/png/gif assets under docs/images/ out of the repo and serve them from https://static.heygen.ai/hyperframes-oss/docs/images/ (backed by s3://heygen-public/hyperframes-oss/docs/images/, CloudFront). Drops ~49MB from the working tree and, more importantly, ~49MB from every future Mintlify build checkout. Combined with the (already-LFS-tracked) producer snapshots, the remaining bloat in 'npx skills add heygen-com/ hyperframes' (see #300) is LFS smudge during clone — separate fix needed in the skills CLI to pass GIT_LFS_SKIP_SMUDGE=1. Changes: - Delete docs/images/** (103 files, ~49MB). Files are uploaded to S3 already. - Rewrite /images/* references in 44 MDX files, TemplateCard.jsx, and catalog-index.json to absolute CDN URLs. - Update README.md img src to CDN URL (renders correctly on GitHub). - Add docs/images/ to .gitignore so regenerated previews aren't committed. - Add scripts/upload-docs-images.sh to sync docs/images/ → S3 after running the preview generators. - Wire up bun run upload:docs-images and bun run generate:catalog-previews scripts in package.json. - Update generator script docstrings to point at the upload step. External contributors can still regenerate previews locally (mintlify dev reads the CDN URLs, so broken previews appear only for newly added items pending a maintainer upload). Maintainers run: bun run generate:catalog-previews --only <name> bun run upload:docs-images Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
vanceingalls
approved these changes
Apr 17, 2026
bin-heygen
approved these changes
Apr 17, 2026
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
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
Move all preview mp4/png/gif assets under
docs/images/out of the repo and serve them from the HeyGen public CDN:Backed by
s3://heygen-public/hyperframes-oss/docs/images/(CloudFront-fronted, long-lived cache headers).Why
Addresses part of #300 (
npx skills add heygen-com/hyperframestimes out at 60s against this 554MB repo).docs/images/is pure generated output — previews are rebuilt fromregistry/sources byscripts/generate-{catalog,template}-previews.ts. Committing them was always hygiene debt.The remaining size contribution to the reported 554MB is the producer regression snapshots in
packages/producer/tests/*/output/output.mp4— those are already LFS-tracked (see.gitattributes). The real reasonskills addblows the 60s timeout is LFS smudge duringgit clone, which is a skills CLI fix (passGIT_LFS_SKIP_SMUDGE=1), not a repo fix. Follow-up PR to be opened againstvercel-labs/skills.How
docs/images/→s3://heygen-public/hyperframes-oss/docs/images/withCache-Control: public, max-age=31536000, immutable.TemplateCard.jsx, andcatalog-index.jsonfrom/images/...to absolute CDN URLs.README.mdimg src to the CDN URL (renders correctly on the GitHub repo page).docs/images/to.gitignorewith a comment pointing at the regenerate/upload workflow.scripts/upload-docs-images.sh(syncsdocs/images/→ S3 with theengineering-767398024897profile) and wired it up asbun run upload:docs-images.docs/images/.Maintainer workflow after this lands
When adding/updating a catalog block, component, or template preview:
External contributors can open PRs with registry + MDX changes; a maintainer runs the generator + upload before merging.
Test plan
curl -sI https://static.heygen.ai/hyperframes-oss/docs/images/readme-demo.mp4→ 200,video/mp4grep -rn '/images/'ondocs/andREADME.md— no bare/images/references remain; every hit is the full CDN URLbunx oxfmt --check+bunx oxlintpass on modified filesREADME.mdpreview on GitHub shows the hero demo gif (will verify after push)Notes for reviewers
git filter-repo) intentionally not done here..gitstays at ~328MB, butgit clone --depth 1(what the skills CLI uses) skips history and downloads a much smaller pack. If we later want to rewrite, it's a one-time operation we can coordinate.GIT_LFS_SKIP_SMUDGE=1fix lands,npx skills add heygen-com/hyperframesshould complete well under the 60s timeout.🤖 Generated with Claude Code