Skip to content

docs: bring the docs up to 0.14.0 - #99

Merged
nhobin219 merged 1 commit into
mainfrom
docs-pass-0.14
Oct 4, 2026
Merged

nhobin219 merged 1 commit into
mainfrom
docs-pass-0.14

Conversation

@nhobin219

Copy link
Copy Markdown
Owner

A docs and docstring pass over what 0.14.0 changed. No behaviour changes.

The one that matters: SECURITY.md

It still said publishing was "opt-in … and off by default so an upgrade cannot make a server writable on its own". Since 0.14.0, every served stream takes publishers, and only a retired one refuses them. It now says a reachable port is a writable one, so authentication isn't optional, and notes the 0.14.0 change. The in-scope list now names "publish into a retired stream", not "a server where publish=True was not set".

Stale

  • The restore fence: seven places stated it as 220: _log, _client, _catchup (a user-facing message), _limits, _stream, and SPEC three times. Since 0.14.0 it's 220 past a replica's record, or 2**40 without one. Each place only needed the number brought up to date; the point (offset gaps are normal) stands.
  • SPEC §8b described restore as replica-only. It now covers the published-table path, the exact shape from the metadata, the two fences, and that retiring then reviving needs no fence.

Missing

  • README: a "Retiring a stream" section, after "Recovering a server".
  • API.md:
    • the migrate, restore and retire signatures in the Stream block. restore's schema, sort_by, config, reserves and revive were documented only in its docstring.
    • StreamRetired and Rejected in the refusals tree. Rejected had been missing since remote publishing.
  • SPEC's failure table: a row for a publisher writing to a retired stream.
  • Stream.retired and Stream.retirement: each now points at the other. One lists the logs a migration sealed; the other says whether this stream is retired.

Gates are clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_01FsSDkeb5rVAxA1FSmKKfQi

SECURITY.md still said publishing was opt-in: since 0.14.0 every served
stream takes publishers, so a reachable port is a writable one. The
restore fence is 2**20 past a replica's record or 2**40 without one,
where seven places said 2**20 alone; SPEC 8b covers the replica-less
path, the exact shape and retire-then-revive. The README gains a
"Retiring a stream" section, API.md the restore and retire signatures
and the StreamRetired and Rejected refusals, and Stream.retired and
Stream.retirement each point at the other.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FsSDkeb5rVAxA1FSmKKfQi
@nhobin219
nhobin219 merged commit 11aed80 into main Oct 4, 2026
6 checks passed
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