Skip to content

docs: refresh README demo and showcase custom styles - #129

Merged
ynqa merged 1 commit into
mainfrom
docs/refresh-demo-gif
Oct 24, 2026
Merged

ynqa merged 1 commit into
mainfrom
docs/refresh-demo-gif

Conversation

@ynqa

@ynqa ynqa commented Oct 24, 2026

Copy link
Copy Markdown
Owner

Replace the README's external GIF with a local demo showing JSON path completion, jq filtering, and custom colors, prompts, indentation, and completion styling. Add the VHS tape, JSON fixture, custom configuration, and recording/optimization commands so the demo can be regenerated.

The GIF is 1000×680, approximately 26 seconds, and 846 KB (47% smaller than the original).

Validation: cargo build --locked --offline, vhs validate tapes/demo.tape, full GIF decoding with FFmpeg, visual checks of default/custom styles and filter results, and git diff --check.

Copilot AI balanced review requested due to automatic review settings October 24, 2026 07:23
@ynqa
ynqa merged commit 9871ba3 into main Oct 24, 2026
8 checks passed
@ynqa
ynqa deleted the docs/refresh-demo-gif branch October 24, 2026 07:24

Copilot AI 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.

🟢 Approval recommended

The documentation and demo assets align with existing application behavior, with no unresolved blocking issues.

No open issues 🎉

What changed in this PR

Refreshes the README demo to showcase jnv’s JSON path completion, jq filtering, and custom styling, with supporting files for regeneration.

Changes:

  • Replaces the external README GIF reference with a local demo.
  • Adds a VHS recording script and recording/optimization commands.
  • Adds a JSON fixture and custom styling configuration.
File Description
tapes/​demo.toml Defines custom prompts, JSON colors, indentation, and completion styles.
tapes/​demo.tape Scripts the demonstration and documents regeneration commands.
tapes/​demo.json Supplies sample JSON for completion and filtering.
README.md Points the demo image to tapes/demo.gif.

Review effort: Balanced

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.

2 participants