Skip to content
Herald Docs

Demo GIF Workflow

Demo GIFs are recorded from synthetic data so documentation and project media can be refreshed without touching a real mailbox.

Prerequisites

Section titled “Prerequisites”
Terminal window
brew install vhs
make build

Regenerate All GIFs

Section titled “Regenerate All GIFs”
Terminal window
for f in demos/*.tape; do vhs "$f"; done

Demo tapes live in demos/*.tape. Output GIFs are written to static/*.gif according to each tape’s Output line. Run tapes from the repository root because they reference ./bin/herald.

Recording Guidance

Section titled “Recording Guidance”
  • Keep tapes focused and under 30 seconds.
  • Use ./bin/herald --demo unless the demo explicitly needs live provider behavior.
  • Prefer terminal sizes that match documentation screenshot states, such as 120x40, 80x24, and 50x15.
  • After changing a visible feature, regenerate the relevant tape.
Section titled “Related Pages”