Skip to content

docs: add README screenshots section + VHS tape scripts#2

Open
posquit0 wants to merge 2 commits into
mainfrom
feat/qw5-readme-screenshots
Open

docs: add README screenshots section + VHS tape scripts#2
posquit0 wants to merge 2 commits into
mainfrom
feat/qw5-readme-screenshots

Conversation

@posquit0

@posquit0 posquit0 commented Jul 5, 2026

Copy link
Copy Markdown
Member

Summary

  • README.md was text-heavy; add a Screenshots section at the top so first impression demos the tool
  • 4 VHS .tape scripts under `docs/tapes/` drive the boot flow only (no real Okta data)
  • `docs/tapes/README.md` documents regeneration: `brew install vhs && vhs docs/tapes/*.tape`
  • `docs/images/.gitkeep` reserves the output directory

Files

  • `README.md` — Screenshots section (4 image slots)
  • `docs/tapes/users_list.tape` — Users list + `/` filter + `d` detail
  • `docs/tapes/logs_tail.tape` — `:logs` + `s` tail toggle
  • `docs/tapes/edit_form.tape` — `e` opens SCR-012 modal
  • `docs/tapes/status_picker.tape` — `s` opens status picker

Test plan

  • `go test ./... -race -count=1` green (docs-only change)
  • manual regen: install vhs, run `vhs docs/tapes/users_list.tape`, verify .gif output

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request adds a screenshots section to the main README and introduces several VHS tape scripts in docs/tapes/ to demonstrate various features of the ota tool, along with documentation on how to regenerate the GIFs. The review feedback correctly points out that the wildcard command vhs docs/tapes/*.tape in the main README is invalid and suggests simplifying the text to refer users to the detailed instructions in the subdirectory.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md Outdated
Comment on lines +13 to +14
source scripts live in [`docs/tapes/`](docs/tapes/); see [`docs/tapes/README.md`](docs/tapes/README.md)
for regeneration instructions (`brew install vhs && vhs docs/tapes/*.tape`). If the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The command vhs docs/tapes/*.tape is invalid because the vhs CLI does not natively support wildcards or multiple tape files as arguments. Running this command directly will result in an error or only process the first matched file. Since the detailed loop instructions are already documented in docs/tapes/README.md, we can simplify this sentence to avoid providing an incorrect command.

Suggested change
source scripts live in [`docs/tapes/`](docs/tapes/); see [`docs/tapes/README.md`](docs/tapes/README.md)
for regeneration instructions (`brew install vhs && vhs docs/tapes/*.tape`). If the
source scripts live in [`docs/tapes/`](docs/tapes/); see [`docs/tapes/README.md`](docs/tapes/README.md)
for regeneration instructions. If the

posquit0 added a commit that referenced this pull request Jul 5, 2026
Address gemini-code-assist review on #2. vhs CLI does not accept
wildcards / multiple .tape args in one invocation. The subdir
docs/tapes/README.md already documents the correct 'for f in' loop;
just point readers there instead of showing an invalid one-liner.
posquit0 added 2 commits July 5, 2026 23:50
README lands text-first. Add a Screenshots section at the top so the first
impression demonstrates the tool, and ship VHS .tape scripts under
docs/tapes/ so contributors can regenerate the assets.

- README.md: Screenshots section with 4 image slots
- docs/tapes/{users_list,logs_tail,edit_form,status_picker}.tape — boot-flow
  demos, no real Okta data
- docs/tapes/README.md: regeneration recipe (brew install vhs && vhs docs/tapes/*.tape)
- docs/images/.gitkeep — target dir for generated .gif output
Address gemini-code-assist review on #2. vhs CLI does not accept
wildcards / multiple .tape args in one invocation. The subdir
docs/tapes/README.md already documents the correct 'for f in' loop;
just point readers there instead of showing an invalid one-liner.
@posquit0 posquit0 force-pushed the feat/qw5-readme-screenshots branch from cffb40b to 15cc8fa Compare July 5, 2026 14:50
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