Repository navigation
docs: refresh README demo and showcase custom styles - #129
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 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
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.
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, andgit diff --check.