Skip to content

docs(promo): add Claude↔Codex demo GIFs to README + docs site#145

Merged
nillo merged 3 commits into
mainfrom
docs/promo-demo-gifs
Jun 18, 2026
Merged

docs(promo): add Claude↔Codex demo GIFs to README + docs site#145
nillo merged 3 commits into
mainfrom
docs/promo-demo-gifs

Conversation

@nillo

@nillo nillo commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Adds the two demo GIFs (approved by the human) to the README and the docs site.

What's here

  • contextrelay-pair.gif (~14s) — ctxrelay --version + ctxrelay status showing Claude + Codex both attached/idle on one ledger. Embedded as the README hero and the docs intro hero.
  • contextrelay-handoff.gif (~16s) — a Claude→Codex review handoff via ctxrelay ledger list + ledger show. Embedded in the README "See a Handoff" section and after the docs "first run" commands.

How they were made (provenance for review)

  • Generated deterministically by scripts/gen-demo-casts.mjs → asciicast v2 .cast → GIF via agg. No live capture.
  • Every command + output format mirrors real ctxrelay output captured live; values are sanitized (abs home paths → ~/code/acme-api, real instance/session IDs → placeholders, status JSON trimmed to representative fields, relatable token-refresh scenario instead of the meta PR-docs(promo): Phase 0 discoverability — README badges, handoff demo, comparison, npm keywords #144 handoff).
  • .cast sources committed alongside the GIFs for reproducibility.

Verification

  • bun run check green.
  • docusaurus build succeeds → the /img/contextrelay-*.gif doc paths resolve (build fails on a missing image).

Asks for Codex

  • Accuracy: does the demo content over/under-state anything (the status fields, the handoff format)?
  • Placement/size: GIFs in the right spots; not too heavy above the fold?

🤖 Generated with Claude Code

Two short demos rendered from asciinema casts that are generated
deterministically from real `ctxrelay` output (no live capture; sanitized
paths/ids; representative token-refresh review scenario):
- contextrelay-pair.gif: `ctxrelay status` shows both agents attached to one ledger.
- contextrelay-handoff.gif: a Claude->Codex review handoff via `ledger list`/`show`.

Embeds: pair GIF as the README hero + docs intro hero; handoff GIF in the
README "See a Handoff" section and after the docs launch commands. Includes
the generator (scripts/gen-demo-casts.mjs) and source .cast files so the demos
are reproducible and reviewable.

Verified: `bun run check` green; `docusaurus build` succeeds (image paths resolve).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
const comment = (text) => {
out(PROMPT);
const s = `${DIM}# ${text}${RST}`;
for (const ch of `# ${text}`) { wait(0.018); }
const comment = (text) => {
out(PROMPT);
const s = `${DIM}# ${text}${RST}`;
for (const ch of `# ${text}`) { wait(0.018); }
…nest framing

Codex cross-review (artifact 367bd776), P2/P3 honesty + reproducibility:
- gen-demo-casts.mjs: seed the typing jitter (mulberry32) so regeneration is
  byte-identical (verified: two regens produce matching SHA-256). Drop the
  "captured live" claim; rename cast 2 from "real" to "representative" handoff.
- Regenerate the .cast files + GIFs from the now-deterministic generator.
- Add a "scripted demo, sanitized values" caption under each GIF in the README
  and the docs intro, so the authenticity posture is explicit.

Verified: bun run check green; docusaurus build succeeds.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@nillo nillo marked this pull request as ready for review June 18, 2026 20:17
@nillo nillo merged commit 61dd9cc into main Jun 18, 2026
4 of 5 checks passed
@nillo nillo deleted the docs/promo-demo-gifs branch June 18, 2026 20:21
nillo added a commit that referenced this pull request Jun 18, 2026
Update the introduction "Current version" callout and the docusaurus
config fallback literal from 3.4.0 to 3.5.0 now that 3.5.0 is the
published release (npm latest = 3.5.0). Layered on top of #145 so the
demo GIFs are preserved.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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.

2 participants