Skip to content

docs: add rename and scope demo GIFs to the README - #841

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

kvlonge merged 1 commit into
mainfrom
docs/readme-rename-demo

Conversation

@kvlonge

@kvlonge kvlonge commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

Why

The README describes renames and scoped macros but doesn't show either. A short recording shows them faster than the text does.

Changes

  • Add the rename demo under the introduction: a model is moved and renamed, and sqb plan migrates the existing table.
  • Add the scope demo under "Change it without rebuilding everything": sqb scope --as-path shows what a move would lose.
  • Both GIFs are recorded from 0.119.2 with the tapes in website/recordings/ and stored in .github/demos/, referenced by absolute URL so they also render on PyPI.
  • The scope tape uses a taller, wider window so the whole report fits, and lists only the relevant files.

Verification

  • Recorded both demos with website/recordings/record.sh and checked the final frames.
  • The public-repository scan passes.

@kvlonge
kvlonge enabled auto-merge (squash) September 26, 2026 14:20
@kvlonge
kvlonge merged commit c61d1f8 into main Sep 26, 2026
17 checks passed
@kvlonge
kvlonge deleted the docs/readme-rename-demo branch September 26, 2026 14:34
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