Skip to content

docs: organise README demos into an In the terminal section - #843

Merged
kvlonge merged 1 commit into
mainfrom
docs/readme-demos
Sep 26, 2026
Merged

kvlonge merged 1 commit into
mainfrom
docs/readme-demos

Conversation

@kvlonge

@kvlonge kvlonge commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

Why

The scope GIF sat under the janitor bullet with no connection to the text around it, and the rename GIF led with a long mkdir && mv line. The README needs its demos placed deliberately, each with a sentence saying what to look at.

Changes

  • Rename GIF (top): shows the folder with tree, one short mv, then sqb plan. Adds a one-line caption.
  • New "In the terminal" section after "What it does", one subsection per demo:
    • a renamed column breaking an enforced contract (sqb compile);
    • a custom rule and a missing test mock (sqb compile);
    • sqb scope --as-path, moved here from the janitor bullet.
  • Tapes wait for the prompt instead of fixed sleeps, and hold the final frame for 10 to 15 seconds.
  • New contract and rules tapes; the quickstart tape is removed.

Verification

  • Recorded all four demos from 0.119.2 with website/recordings/record.sh and checked every final frame.
  • The public-repository scan passes.

@kvlonge
kvlonge merged commit b274479 into main Sep 26, 2026
17 checks passed
@kvlonge
kvlonge deleted the docs/readme-demos branch September 26, 2026 18:21
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