Skip to content

docs: 1.11 - #325

Merged
arv merged 20 commits into
mainfrom
arv/docs-1.11
Oct 16, 2026
Merged

arv merged 20 commits into
mainfrom
arv/docs-1.11

Conversation

@arv

@arv arv commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Everything Zero 1.11 needs in the docs, in one PR, so it can merge on release day: the release notes plus the feature docs they link to. This replaces #314, #318, #320, #321, #322, #323 and #324.

Commit Was Pages
'cached' result type #318 queries
'initializing' connection state, new lifecycle diagram #320 connection
Storage failures, zero.kvStore #321 connection, react-native
Query identity #322 react
Mutator return values, tx.retryOn(), isolation levels #323 mutators, server-zql
Config: legacy queries, operator password, readiness, hydration limits; corrected defaults (including the one-week CVR GC default from #314); removed VFS options #324 zero-cache-config, deprecated/ad-hoc-queries, debug/slow-queries
Release notes, including the Mac and React Native benchmark results new release-notes/1.11, release-notes/index
Plainer wording for the release notes and the feature docs new the pages above
API Reference link to 1.11.0 new lib/routes-config.ts
Search index regenerated after each content change assets/search-index.json

The release notes link straight to the new sections. I checked every /docs/... link and anchor in the changed pages against the headings on this branch, and every changed page compiles with @mdx-js/mdx.

Open before merging:

  • React Native benchmark results
  • Decide whether partial indexes are announced: not in 1.11, since they are off by default
  • Replication-manager SIGTERM drain: fixed in code; no docs change needed
  • Redraw the lifecycle diagram with the initializing state (now lifecycle.svg)
  • Re-sign the commits. They were signed by a cloud session key that "Verify Signed Commit Authors" doesn't accept:
    git fetch origin arv/docs-1.11 && git checkout arv/docs-1.11
    git rebase -x 'git commit --amend --no-edit -S' origin/main
    git push --force-with-lease origin arv/docs-1.11
  • Regenerate the search index again if anything else changes before merging
  • After 1.11.0 is on npm, check that the API Reference link (https://npmx.dev/package-docs/@rocicorp/zero/v/1.11.0#class-Zero) loads

🤖 Generated with Claude Code

https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ

@vercel

vercel Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
zero-docs Ready Ready Preview Oct 16, 2026 10:41am UTC

Request Review

arv commented Oct 14, 2026

Copy link
Copy Markdown
Contributor Author

Verify Signed Commit Authors fails on all 8 commits because a cloud Claude Code session signed them with its own SSH key, which isn't in rocicorp/.github's allowed signers. The docs change itself is fine, and a re-run won't help. Re-signing every commit at once with an allowed key fixes it:

git fetch origin arv/docs-1.11 && git checkout arv/docs-1.11
git rebase -x 'git commit --amend --no-edit -S' origin/main
git push --force-with-lease origin arv/docs-1.11

Generated by Claude Code

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Unresolved documentation accuracy issues remain in release-note claims and configuration guidance.

4 open findings
What changed in this PR

Documents Zero 1.11 features, configuration changes, migration guidance, and release notes.

Changes:

  • Adds client, server, mutator, query, and connection documentation.
  • Updates configuration options and defaults.
  • Adds release notes and related documentation links.
File Summary
contents/​docs/​zero-cache-config.mdx Documents new options and corrected defaults.
contents/​docs/​server-zql.mdx Adds transaction isolation-level guidance.
contents/​docs/​release-notes/​index.mdx Links to the 1.11 release notes.
contents/​docs/​release-notes/​1.11.mdx Adds 1.11 features, performance data, fixes, and breaking changes.
contents/​docs/​react.mdx Documents query identity and interning.
contents/​docs/​react-native.mdx Links to storage-failure guidance.
contents/​docs/​queries.mdx Documents cached results and preload behavior.
contents/​docs/​mutators.mdx Documents retries and returned data.
contents/​docs/​deprecated/​ad-hoc-queries.mdx Documents legacy-query configuration.
contents/​docs/​debug/​slow-queries.mdx Documents operator-password access.
contents/​docs/​connection.mdx Documents initialization and storage failures.

🧠 Review effort: Lite


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread contents/docs/release-notes/1.11.mdx
Comment thread contents/docs/release-notes/1.11.mdx Outdated
Comment thread contents/docs/release-notes/1.11.mdx Outdated
Comment thread contents/docs/connection.mdx

arv commented Oct 15, 2026

Copy link
Copy Markdown
Contributor Author

Copilot review (thread replies are blocked by a pending review, so answering here):

  • "v4 backups" (r4281201897): fixed in ccab907. It now says "To keep writing legacy WAL backups with Litestream v0.3", matching zero-cache-config.
  • React Native aggregate (r4281201839): the count was wrong, and ccab907 fixes it. The 56 included three JSON.parse control benchmarks. Without them there are 53 benchmarks with a geometric mean of 1.68x, so the text now says about 1.7x. 48 of the 53 improved by more than 5%. The ranges are from the same run: hydration 1.64x to 4.77x, pushes 1.25x to 1.84x, transactions of edits 1.23x to 2.23x. The chart shows five common operations, not all 53.
  • React Native cold start, about 8x (r4281201776): this is the same cold-boot benchmark run on Hermes (iPhone 17 Pro simulator, release build), 58,768 ms to 7,187 ms, which is 8.18x. It isn't charted because the absolute React Native times don't represent a real app. The benchmark pushes about 30,000 rows one at a time through Hermes' interpreter, while the real client bulk-loads them, so only the ratio is meaningful. The claim stays as is.
  • Lifecycle image (r4281201985): fixed in e275345 and 8775725. lifecycle.png is replaced by lifecycle.svg, which starts in initializing.

Generated by Claude Code

Comment thread contents/docs/connection.mdx Outdated
arv and others added 20 commits October 16, 2026 12:39
Adds a Cached Results section: a query whose result the server confirmed
during a previous session starts as 'cached', becomes 'complete' once the
server returns it in this session, and goes back to 'unknown' if the stored
result is evicted first. Lists all result types, and documents
run({type: 'cached'}) and the cached promise from preload().
…adiness and hydration options

Add ZERO_ALLOW_LEGACY_QUERIES, ZERO_OPERATOR_PASSWORD,
ZERO_REPLICATION_LAG_INITIAL_READINESS_THRESHOLD_MS,
ZERO_REPLICATION_LAG_MAX_READINESS_DELAY_MS,
ZERO_VIEW_SYNCER_HYDRATION_BUDGET_MS and
ZERO_VIEW_SYNCER_QUERY_HYDRATION_TIMEOUT_MS.

Update defaults (replication lag report interval, CVR GC threshold,
flow control consensus proportion, auth revalidate/retransform
intervals, litestream v5 backups, multipart concurrency), remove the
litestream VFS options, and move ZERO_CHANGE_STREAMER_MODE and
ZERO_LITESTREAM_MIN_CHECKPOINT_PAGE_COUNT to deprecated flags.
…ction

Leads with client cold start, adds the React Native query engine results, and mentions cold start on React Native.
Fixes now describe the bug, as in earlier notes, instead of repeating "no longer". Shorter sentences, no colon lead-ins. Same facts, links and credits.
Turns the "A few things to know" and "Keep in mind" lists into prose, drops the bold lead-in bullets in Storage Failures, and trims repeated "X, not Y" phrasing. Headings, anchors, code and facts are unchanged.
…ails

The pre-v5 backup format is Litestream v0.3 (legacy WAL), not v4.

The React Native aggregate counted the three JSON.parse control
benchmarks. Without them it is 53 benchmarks with a geometric mean of
1.68x, so say about 1.7x.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
…ts in initializing

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
The previous commit removed lifecycle.png without adding its
replacement. Add lifecycle.svg and point the connection docs at it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
The diagram now has Connected to Disconnected when the tab is hidden and
Disconnected to Connecting when it is visible again. The Disconnected
section says Zero waits for the tab to be visible instead of retrying
every 5 seconds after a hidden-tab disconnect.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
…confirmed

Local rows were already shown right away as 'unknown'. What 1.11 adds is
knowing that they are a result the server confirmed in an earlier session.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
@arv
arv added this pull request to the merge queue Oct 16, 2026
Merged via the queue into main with commit 618142c Oct 16, 2026
6 checks passed
@arv
arv deleted the arv/docs-1.11 branch October 16, 2026 10:42

This branch was successfully deployed

1 active deployment
Preview — f79d2fc6 Deployed Oct 16, 2026 by vercel[bot]
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