docs: replace getting-started.gif with VHS-driven recording

Kai Armstrongrequested to merge
karmstrong/demos-vhs-getting-started into main

Summary

  • Replaces the blank glabgettingstarted.gif embedded in the README and docs with a VHS-driven recording showing glab repo clone, glab issue list, and glab mr list against this project.
  • Adds docs/demos/ as the canonical home for tape files and their generated output, plus a docs/demos/README.md covering installation, authentication via GITLAB_TOKEN, and conventions for new demos.
  • Extracts shared styling into docs/demos/base.tape so future demos (e.g. stack, ci) can Source it instead of redefining theme/dimensions/typography.
  • Custom GitLab-flavored dark theme with a subtle dark grey margin, rounded corners, macOS-style window bar, and a tanuki orange ❯ prompt.

Does not implement the stretch goal from the issue around regenerating GIFs in CI via the VHS Docker image — left for a follow-up.

Test plan

  • Verify docs/source/img/getting-started.gif renders on the rendered README at the project root
  • Verify the same image renders on docs/source/_index.md
  • Re-run cd docs/demos && GITLAB_TOKEN="<your-personal-access-token>" vhs getting-started.tape and confirm the GIF reproduces cleanly
  • Run make gen-docs to confirm the generator emits the new getting-started.gif filename

Closes #8309 (closed)

Edited by Kai Armstrong

Merge request reports