Add privacy-safe CLI and TUI recordings#123
Open
tony wants to merge 11 commits into
Open
Conversation
why: Reproducible recordings show agentgrep's terminal surfaces without reading a developer's real history. Keeping the sources beside their rendered artifacts makes every preview refreshable. what: - Seed synthetic Codex, Claude, Cursor, and Gemini stores - Record CLI and TUI workflows as GIF, MP4, WebM, and asciinema casts - Add still poster frames for lightweight documentation previews - Remove ambient color controls so Textual keeps its intended palette
why: The quickstart introduces both terminal interfaces with command snippets alone. Still previews make their output visible immediately without forcing an animated download. what: - Embed a ranked-search preview beside the CLI quickstart - Embed an explorer preview beside the TUI invocation - Link both stills to their hosted MP4 recordings
why: The CLI reference explains each output shape in prose, but readers cannot see its hierarchy, highlighting, or terminal color at a glance. what: - Put the root help preview on the CLI landing page - Add search, grep, and find previews to their command references - Link each still preview to its hosted MP4 recording
why: The explorer's search, results, detail, and sticky-filter panes are spatial interactions that are easier to understand from the real UI. what: - Add an explorer preview after the launch examples - Place a filtered-results preview beside the sticky-filter guide - Link both still previews to their hosted MP4 recordings
why: Sphinx copies the whole demo source tree from `_static` by default, which would publish recorder inputs, alternate renders, and duplicate poster files beside the linked videos. what: - Keep casts, tapes, helpers, GIFs, WebMs, and poster sources out - Leave MP4 recordings available at stable `_static` URLs - Let Sphinx copy referenced PNG posters through its image pipeline
why: Static posters linked to recordings do not provide in-page playback or reserve a tested video surface across Sphinx builders. what: - Add a local-only terminal-demo directive with native MP4 playback. - Infer intrinsic dimensions from required posters and publish responsive CSS. - Cover asset validation, builder fallbacks, playback, and copied files.
why: CLI readers should be able to play each primary command demonstration without leaving the command reference. what: - Embed the help, search, grep, and find MP4 recordings. - Retain explicit posters and accessible descriptions for every demo.
why: The explorer overview and sticky-filter workflow are easier to understand when their recordings play where those interactions are documented. what: - Embed the primary TUI and loaded-result filter recordings. - Keep explicit posters and accessible descriptions for both workflows.
why: Explicit poster geometry prevents the README from shifting as the linked CLI and TUI previews load. what: - Declare the search poster's intrinsic width and height. - Declare the reframed TUI poster's intrinsic width and height.
why: The original wide captures made explorer text too small when embedded in the documentation and did not foreground a populated detail pane. what: - Render both TUI workflows at 1200 by 700 with an 18-pixel font. - Shorten each recording around one meaningful loaded-result interaction. - Extract matching populated posters and regenerate GIF, MP4, and WebM files.
why: The moving pnpm 11 range began resolving to 11.12.0, whose bootstrap self-update crashes in action-setup before the documentation build starts. The previous docs runs proved 11.11.0 against the committed lockfile. what: - Pin the docs workflow to the last known-good pnpm 11 release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/_static/demos/.search,grep,find, andui.{terminal-demo}directive that derives intrinsic geometry from an explicit poster and emits a native, no-JavaScript MP4 player with accessible builder fallbacks.Color and safety
NO_COLORandFORCE_COLORat the recording boundary and set truecolor explicitly. The old environment made Textual install its no-color filter, which stripped the TUI palette and materialized terminal-default backgrounds as black.Preview
CLI
TUI
Verification
rm -rf docs/_build; uv run ruff check . --fix --show-fixes; uv run ruff format .; uv run ty check; uv run py.test --reruns 0 -vvv; just build-docs;preload="none"._static/demos/, with no recorder sources or alternate media in the static demo copy.