Skip to content

docs: rerecord README media and add asciinema casts - #231

Merged
danielkov merged 2 commits into
mainfrom
chore/readme-recordings
Sep 16, 2026
Merged

danielkov merged 2 commits into
mainfrom
chore/readme-recordings

Conversation

@danielkov

Copy link
Copy Markdown
Contributor

Recordings had drifted from the implementation, so all eight are retaken against current main with the release binary.

  • scripts/readme-media/theme.tape holds the shared VHS setup: kitagent palette, IBM Plex Mono, 2400x1440 at 30px. Every tape sources it.
  • Each tape wraps the session in asciinema rec, so one run produces a 2x GIF for the README and a .cast for text-based playback on kitagent.dev.
  • scripts/readme-media/trim-cast.py strips the shutdown burst and hidden setup from each cast and pads a hold at the end.
  • New install and picker recordings. The install placeholder in the README is replaced with the GIF.
  • Subagents and background GIFs are palette-optimized to keep them under 5MB.
  • scripts/readme-media/out/ is ignored.

Requires vhs, asciinema 3.x and the IBM Plex Mono font to regenerate.

Recordings had drifted from the implementation. Every tape now sources
theme.tape (shared palette, IBM Plex Mono, 2400x1440 at 30px) and wraps
the session in asciinema rec, so one run yields a 2x GIF for the README
and a .cast for text-based playback on the website. trim-cast.py cuts
the shutdown burst and hidden setup from each cast and pads a hold at
the end.

Adds install and picker recordings, replacing the install placeholder
in the README.

@kit-code-agent kit-code-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The installation recording unconditionally redirects Docker commands to Podman, introducing an undocumented prerequisite that can make regeneration record a failed container invocation.

Comment thread scripts/readme-media/install.tape Outdated

@kit-code-agent kit-code-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found. The changes look good to merge.

@danielkov
danielkov merged commit f039a01 into main Sep 16, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant