James Russo
4ae5c0340f
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>
32 lines
1.2 KiB
Bash
Executable File
32 lines
1.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Upload docs/images/ to the HeyGen public CDN.
|
|
#
|
|
# Docs previews (mp4/png/gif) are served from https://static.heygen.ai/hyperframes-oss/docs/images/
|
|
# rather than committed to the repo. After regenerating previews with
|
|
# `scripts/generate-catalog-previews.ts` or `scripts/generate-template-previews.ts`,
|
|
# run this script to publish the new files.
|
|
#
|
|
# Requires AWS credentials for the heygen engineering account (profile: engineering-767398024897).
|
|
# Contributors without AWS access: open a PR with the HTML/MDX changes and a
|
|
# maintainer will run the generators + this upload before merging.
|
|
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
|
SRC="$REPO_ROOT/docs/images/"
|
|
DEST="s3://heygen-public/hyperframes-oss/docs/images/"
|
|
PROFILE="${AWS_PROFILE:-engineering-767398024897}"
|
|
|
|
if [ ! -d "$SRC" ]; then
|
|
echo "No docs/images/ directory to upload — nothing to do."
|
|
exit 0
|
|
fi
|
|
|
|
echo "Uploading $SRC → $DEST (profile: $PROFILE)"
|
|
aws --profile "$PROFILE" s3 sync "$SRC" "$DEST" \
|
|
--cache-control "public, max-age=31536000, immutable" \
|
|
--metadata-directive REPLACE
|
|
|
|
echo "Done. Files are live at https://static.heygen.ai/hyperframes-oss/docs/images/"
|