docs: update demo recording and add assets guide - #349
Merged
Conversation
The asciinema recording behind assets/demo.svg had drifted from what the CLI actually prints: - zuke setup prints per-file create lines (including zuke.json and .gitignore) and a Done summary, not a single Scaffolded line, and the non-interactive form needs --yes. - The shown zuke.ts now pins jsr:@zuke/core@^1 / @zuke/deno@^1 and declares the .description() calls that the --list frame displays. - --list output is plain text with two-space column padding, never colored. - The executor prints a blank line after each target's footer. Every output line in the new cast was verified byte for byte against a real run of the current renderer. Also adds realistic tool output (deno lint / deno test lines), a longer end-of-loop hold on the summary, and assets/README.md documenting how to regenerate the SVG. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0187myXRLofTjVoCkzN51tG8
Contributor
|
🤖 Zuke AI review 🔎 security review —
|
Contributor
|
🤖 Zuke AI review 🔎 generic review —
|
| Finding | Reason |
|---|---|
| Demo cast records a different scaffold command surface than the documented setup flow | The updated README explicitly documents that the cast must match the real CLI byte-for-byte and the diff shows the cast was regenerated to match the new scaffold output, so no concrete mismatch is evidenced here. |
Recorded --list output drops the documented column padding and ANSI styling |
The new README says --list is plain text with two-space column padding, and the cast’s Targets: output with lint Lint the workspace matches that documented shape rather than dropping it. |
| SVG asset was regenerated from the updated cast without a corresponding verification note in source | The change adds an assets README stating demo.svg is rendered from demo.cast and gives the regeneration command, so the synchronization concern is already documented rather than an introduced code-quality defect. |
The changes mostly refresh demo assets, but the recorded outputs now diverge from the documented CLI format in ways that could make the example misleading.
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
2 participants
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.
What & why
Updates the asciinema demo recording (
demo.cast) to reflect current CLI output and scaffolding behavior. The recording now shows:deno run -A jsr:@zuke/cli setup --yescommand with interactive outputzuke.tstemplate with explicit.description()calls on targets@^1)--listoutput format (no ANSI styling on headers)Also adds
assets/README.mddocumenting how the demo recording is maintained and how to regenerate the SVG rendering.Related issues
N/A
Checklist
type(scope): summary).demo.castoutput verified to match real CLI byte-for-byte.demo.svgregenerated from updated cast.https://claude.ai/code/session_0187myXRLofTjVoCkzN51tG8