docs: add README screenshots section + VHS tape scripts#2
Conversation
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
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.
| 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 |
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.
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.
cffb40b to
15cc8fa
Compare
Summary
Files
Test plan