Skip to content

readme: show the quickstart recording and three badges at the top - #11

Merged
fredaime merged 1 commit into
mainfrom
vis/readme-hook
Nov 7, 2026
Merged

fredaime merged 1 commit into
mainfrom
vis/readme-hook

Conversation

@fredaime

@fredaime fredaime commented Nov 7, 2026

Copy link
Copy Markdown
Owner

What this changes

README.md only, as a dedicated change (CONTRIBUTING: a README change does nothing else). Five lines are added above the existing content, and nothing is moved:

  • Three badges beside the two index badges already there:
    • the gate workflow's status on main;
    • the licence, Apache-2.0;
    • the Python versions the index declares (3.12, 3.13, 3.14).
  • The quickstart recording, linked to its description. The control plane renders it in docs/demo/ (demo: record a selection of the 0.3.3 quickstart, with the tape that types it sayfirst-control-plane#13). It is embedded by absolute raw.githubusercontent.com URL because this file is also the distribution's page on the index, where a relative link breaks.

How it was checked

  • Gate. SAYFIRST_CONTRACT_SOURCE=../sayfirst-control-plane SAYFIRST_CONTRACT_REF=v0.3.3 ./scripts/gate.sh: "full green — format, lint, 57 test modules, the closure check", 1133 passed, 2 skipped, exit 0.
  • Review. A separate reviewer checked the badge targets against ci.yml, LICENSE and the index's classifiers. Its one finding is fixed in this commit: the GIF's alt text now says what the recording is, a selection of the quickstart, and that the export ends with coverage unknown.

Merge order

Merge after fredaime/sayfirst-control-plane#13; until then the GIF's URL returns 404.

🤖 Generated with Claude Code

https://claude.ai/code/session_0162drQfasSuUstL4ntW1SkQ

Above the existing content, and nothing else moved: the gate workflow's
status, the licence and the Python versions the index declares, beside the two
index badges already there, and the quickstart recording the control plane
renders in docs/demo/, linked to its description. The recording is embedded by
absolute URL because this file is also the distribution's page on the index,
where a relative link breaks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162drQfasSuUstL4ntW1SkQ
Signed-off-by: fredaime <frederic.aime@gmail.com>
@fredaime
fredaime merged commit 4817676 into main Nov 7, 2026
13 checks passed
@fredaime
fredaime deleted the vis/readme-hook branch November 7, 2026 22:13
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