Skip to content

Generate and add docs tape images#111

Closed
murrayju wants to merge 2 commits intomainfrom
ox/add-docs-tape-images
Closed

Generate and add docs tape images#111
murrayju wants to merge 2 commits intomainfrom
ox/add-docs-tape-images

Conversation

@murrayju
Copy link
Member

Summary

  • generate the existing VHS tapes and add the resulting GIFs under docs/images
  • embed the generated screenshots in the TUI and usage docs pages
  • update the tape outputs and generator to use docs/images and work in this environment

Testing

  • ./docs/tapes/generate.sh
  • ./bun run check (fails in src/services/dockerFiles.test.ts because Docker cannot register the Alpine layer in this environment: unshare: operation not permitted)

Copilot AI review requested due to automatic review settings March 17, 2026 16:36
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Ox Agent seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation workflow for VHS-generated TUI/CLI recordings by standardizing outputs under docs/images/ and embedding the resulting GIFs into the docs pages.

Changes:

  • Move VHS tape outputs from docs/assets/ to docs/images/ and update the generator script accordingly.
  • Embed generated GIFs into docs/usage.md and most of docs/tui.md.
  • Add newly generated GIF artifacts under docs/images/.

Reviewed changes

Copilot reviewed 10 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/usage.md Embeds the follow-mode GIF (images/start-task.gif).
docs/tui.md Replaces screenshot placeholders with embedded GIFs for several TUI sections; command palette remains a placeholder comment.
docs/configuration.md Updates screenshot placeholder path to docs/images/.
docs/tapes/*.tape Updates Output paths to write GIFs into docs/images/.
docs/tapes/generate.sh Updates tape generation to use docs/images/ and wraps Chromium invocation with --no-sandbox.
docs/tapes/README.md Updates documentation to reference docs/images/ as the output directory.
docs/images/*.gif Adds the generated GIF artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.


SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
TMP_DIR="$(mktemp -d)"
Comment on lines +27 to +32
if command -v chromium >/dev/null 2>&1; then
CHROMIUM_BIN="$(command -v chromium)"
elif command -v chromium-browser >/dev/null 2>&1; then
CHROMIUM_BIN="$(command -v chromium-browser)"
else
echo "Error: chromium not found on PATH" >&2
Press `ctrl+p` from any view to open the command palette -- a fuzzy-searchable list of all available actions.

<!-- screenshot: docs/assets/command-palette.gif -->
<!-- screenshot: docs/images/command-palette.gif -->
@murrayju murrayju closed this Mar 17, 2026
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.

3 participants