Refresh v0.14.0 documentation and demo tapes - #97
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Refreshes promkit’s v0.14.0 documentation and recorded VHS demo tapes to align with the current architecture and to add a CSV example + demo assets, keeping shared fixtures version-controlled while continuing to ignore generated GIF outputs.
Changes:
- Updated the main README feature overview and added an examples index plus a documented CSV example.
- Added a CSV VHS tape and a self-contained CSV fixture; updated JSON/YAML tapes to use shared Kubernetes fixtures.
- Adjusted
.gitignoreso tape fixtures remain tracked while generatedtapes/*.gifoutputs stay ignored.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tapes/yaml.tape |
Updates the YAML demo to run against the new shared Kubernetes YAML fixture and adjusts navigation steps. |
tapes/kubernetes.yaml |
Adds a version-controlled Kubernetes YAML fixture used by the YAML demo tape. |
tapes/kubernetes.json |
Adds a version-controlled Kubernetes JSON fixture used by the JSON demo tape. |
tapes/json.tape |
Updates the JSON demo to run against the new shared Kubernetes JSON fixture and adjusts navigation steps. |
tapes/csv.tape |
Adds a new CSV demo tape for recording the CSV viewer interaction. |
tapes/csv.csv |
Adds a self-contained CSV fixture used by the CSV demo tape. |
README.md |
Refreshes v0.14 feature docs, adds an examples table of contents, documents the CSV example, and fixes the query-selector binary name. |
promkit-widgets/README.md |
Streamlines widget documentation into a concise getting-started guide, widget list, and responsibility boundaries. |
.gitignore |
Ensures tape fixtures stay tracked while keeping generated tape GIFs ignored. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
promkit-widgetsREADME into a concise introduction, setup guide, widget list, and responsibility overviewtapes/query-selectorbinary nameValidation
cargo test -p csv-viewervhs validate 'tapes/{csv,json,yaml}.tape'git diff --check