Skip to content

Refresh v0.14.0 documentation and demo tapes - #97

Merged
ynqa merged 4 commits into
v0.14.0/devfrom
docs
Jul 28, 2026
Merged

Refresh v0.14.0 documentation and demo tapes#97
ynqa merged 4 commits into
v0.14.0/devfrom
docs

Conversation

@ynqa

@ynqa ynqa commented Jul 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • refresh the main feature overview around the v0.14 architecture:
    • application-owned prompt composition
    • optional runtime and terminal lifecycle
    • viewport-aware rendering
    • reusable, feature-gated widgets
  • streamline the promkit-widgets README into a concise introduction, setup guide, widget list, and responsibility overview
  • add an example index with short descriptions and document the CSV viewer
  • add a CSV demo tape and self-contained CSV fixture
  • update the JSON and YAML tapes to use equivalent Kubernetes fixtures stored under tapes/
  • keep tape fixtures tracked while generated GIFs remain ignored
  • fix the documented query-selector binary name

Validation

  • cargo test -p csv-viewer
  • vhs validate 'tapes/{csv,json,yaml}.tape'
  • rendered and visually checked the CSV, JSON, and YAML tapes
  • git diff --check

Copilot AI review requested due to automatic review settings July 28, 2026 07:53

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.

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 .gitignore so tape fixtures remain tracked while generated tapes/*.gif outputs 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.

@ynqa
ynqa merged commit 43ef6fe into v0.14.0/dev Jul 28, 2026
2 checks passed
@ynqa
ynqa deleted the docs branch July 28, 2026 07:56
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