Skip to content

docs: point the README diff sample at the demo GIF too - #45

Merged
Kiran01bm merged 1 commit into
mainfrom
kiran01bm/readme-diff-sample-trim
Aug 18, 2026
Merged

docs: point the README diff sample at the demo GIF too#45
Kiran01bm merged 1 commit into
mainfrom
kiran01bm/readme-diff-sample-trim

Conversation

@Kiran01bm

Copy link
Copy Markdown
Collaborator

Trims the README's last verbatim console sample — the diff section now points at its demo GIF and the JSON contract doc, matching improve/refuse/lint.

Why

After the improve/refuse/lint samples were replaced with pointers to the animated demos, the diff console block was the one remaining hand-maintained text rendering — the same drift liability the other three shed.

What

  • README: the diff section keeps its declarative/--sql/exit-2 prose and points at docs/demos/diff-greenfield.gif and docs/cli-output-examples.md; the section intro no longer promises a verbatim sample.
  • docs/cli-output-examples.md: the back-pointer for the human text rendering now goes to the animated demos alone.
Before                              After
┌───────────────────────────┐      ┌───────────────────────────┐
│ README                    │      │ README                    │
│  hero GIF (improve)       │      │  hero GIF (improve)       │
│  diff:    prose + console │      │  diff:    prose ──┐       │
│  improve: prose ──┐       │      │  improve: prose ──┤       │
│  refuse:  prose ──┼ links │      │  refuse:  prose ──┼ links │
│  lint:    prose ──┘       │      │  lint:    prose ──┘       │
└───────────────────────────┘      └───────────────────────────┘

The last verbatim console sample duplicated what the greenfield demo
records; the diff section now keeps its gating prose and points at the
GIF and the JSON contract doc, matching improve/refuse/lint, and
cli-output-examples.md's back-pointer follows the demos.
@Kiran01bm
Kiran01bm marked this pull request as ready for review August 18, 2026 12:10
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@Kiran01bm
Kiran01bm merged commit 8675d0b into main Aug 18, 2026
8 checks passed
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.

1 participant