diff --git a/docs/public/videos/README.md b/docs/public/videos/README.md index 2eb1af5d33..a733b68bda 100644 --- a/docs/public/videos/README.md +++ b/docs/public/videos/README.md @@ -29,12 +29,44 @@ import Video from '@components/Video.astro'; - Consider adding poster images (thumbnails) for better UX - Compress videos appropriately for web use +## Generating Poster Images + +Poster images (video thumbnails) provide a better user experience by showing a preview frame before the video loads. Poster images are automatically detected by the Video component - they should be placed alongside video files with the same name but a `.png` extension. + +For example: +- `create-workflow.mp4` → `create-workflow.png` (poster) +- `demo.mp4` → `demo.png` (poster) + +To generate poster images for all videos in this directory: + +```bash +# From the repository root +./scripts/generate-video-posters.sh +``` + +This script will: +- Extract a frame at 1 second from each MP4 video +- Generate high-quality PNG poster images (1920x1080) +- Save them alongside the video files with `.png` extension + +The Video component automatically detects and uses these poster images: + +```mdx +