docs: point README samples at the demo GIFs - #44
Merged
Conversation
The improve, refuse, and lint verbatim console samples duplicated what the animated demos record: each section keeps its exit-code/gating prose and points at the GIF and the JSON contract doc, the diff sample stays as the one copyable text rendering, and docs/demos/README.md inlines all four GIFs in per-tape sections. Also reverts the neutral-prompt review nit as a deliberate authorial choice; GIFs re-rendered to match.
Kiran01bm
changed the title
Kiran01bm
marked this pull request as ready for review
August 18, 2026 12:01
Kiran01bm
requested review from
JashLal,
aparajon,
eeSeeGee,
jayjanssen,
jemiahw and
morgo
as code owners
August 18, 2026 12:01
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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
1 participant
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.
Trims the README's duplicated console samples in favor of the animated demos and inlines all four GIFs in the demos page.
Why
After the demos landed (#42), the improve, refuse, and lint sections carried both a GIF and a near-identical verbatim console block — two renderings of the same output to keep in sync by hand. The demos page described the recordings in a table without showing them.
What
docs/cli-output-examples.md; the diff sample stays as the one copyable text rendering, withcli-output-examples.md's back-pointer updated to match. The lint section's exit-code claim now matches the code (error-severity findings exit non-zero; warnings alone pass).docs/demos/README.md: the tape table becomes per-tape sections with each GIF embedded.