Skip to content

Rebuild the README GIFs around normal usage - #46

Merged
woksin merged 3 commits into
mainfrom
chore/rebuild-readme-gifs
Jul 28, 2026
Merged

Rebuild the README GIFs around normal usage#46
woksin merged 3 commits into
mainfrom
chore/rebuild-readme-gifs

Conversation

@woksin

@woksin woksin commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

The README GIFs showed a broken system throughout; they now show the CLI in normal use, with one clip about a failure.

Changed

  • README GIFs re-recorded against a healthy, connected store: a usage tour, the workbench, tab completion, and one triage clip.
  • Demo fixture keys events by domain identifiers (ISBN, member handle) instead of GIDs, so CLI output is readable.
  • Corrected the observer-column guidance: with a connected client every observer reaches tail+1, and it is LastHandled# that lags, not Next#.
  • Re-measured the output-format byte counts.

woksin and others added 3 commits July 28, 2026 14:31
Two changes, both aimed at what the recordings show.

Event source ids are now the domain's own — an ISBN keys a book, a handle keys a
member — instead of generated GUIDs. Chronicle takes any string, and it is the
difference between a read model table of readable rows and two columns of
wrapped hex.

The serve and serve-failing modes keep the client connected. A seeder that has
exited leaves every observer Disconnected, which looks like a broken system when
it is only a stopped process.

serve-failing arms the fault before connecting rather than after: Chronicle
retries a pending failed partition the moment a client reconnects, so a late arm
lets that first retry succeed and clears the failure the clip is about.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The set was built entirely around a broken store. The hero opened on red crosses
and a four-deep stack trace, three observers showed Disconnected because the
seeder had exited, and the palette clip led with a failure row. It read as a tool
for when everything is on fire rather than a tool for looking at an event store.

Three of the four clips now run against a healthy connected system:

- demo      is it healthy, what happened, what state did that produce
- workbench filtering a view, then searching every artifact kind at once
- completions tab completion asking the server, using a read-only command
- triage    the one failure clip: one stopped partition in a healthy store

completions no longer types `observers replay` to demonstrate completion. It was
never run, but a stray keystroke in a tape stood between a demo and a replay, and
completing a read model name shows the same thing without that.

record.sh renders the set and asserts the store is in the state a clip needs
before rolling. A clip recorded against the wrong state still produces a
perfectly good-looking GIF of the wrong thing, which is how two broken clips
nearly shipped.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Rendering against a live client exposed two things the README had wrong, both
artifacts of a fixture whose seeder had exited rather than facts about the tool.

Next# does not sit behind the log tail for observers that skip event types — with
a connected client every observer reaches tail+1. It is LastHandled# that
differs, because it records the last event each one actually cared about. The
note explaining the columns said the opposite.

Output-format byte counts are re-measured; shorter identifiers moved them.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@woksin woksin added the patch label Jul 28, 2026
@woksin
woksin merged commit a93da73 into main Jul 28, 2026
@woksin
woksin deleted the chore/rebuild-readme-gifs branch July 28, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant