fix(docs): align documentation with server 0.9.0 - #95
Merged
Merged
Conversation
Server guidance drifted from configuration, authentication, storage and deployment behavior. Correct the verified claims and examples, qualify historical benchmarks, and document safe result metadata. Validate source startup, all benchmark kinds, Docker and Helm examples, and built pages in both themes.
Document the matching source build, credential precedence and command limits. Correct retention and durability options, ignored ID flags, unsupported operations and executable examples. Verify the examples against the worktree server and a private keyring. Website build, typecheck, links, headers and both-theme renders pass.
SDK setup and examples used incompatible releases, stale APIs and incorrect authentication, offset and ownership guarantees. Align the language guides with verified source or edge packages. Correct runnable samples and describe transport, retry, durability and example lifecycle limits.
Correct connector setup, payload formats, checkpoints, retries and failure semantics against the audited source. Include executable examples and state the remaining delivery and configuration limits.
Correct transport choices, resource requirements, rebalancing and processing guarantees. Scope historical benchmarks and distinguish connector telemetry from the broker export limitations.
Correct replay limits, connector counts, UI features and telemetry. Describe the memory budget, Linux I/O and optional affinity in the rendered overview while retaining recorded benchmark blockers.
spetz
approved these changes
Sep 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation drifted from the 0.9.0 server. Pages described
stale APIs, incompatible SDK releases, wrong authentication, offset
and ownership guarantees, and configuration options that the server
does not accept. Old benchmark numbers read as current results.
This branch audits every section against the 0.9.0 source and
corrects the claims. The audit covers introduction, clustering,
server, CLI, binary protocol, MCP, Web UI, SDK guides, connectors,
FAQ and the docs landing page. Examples now run as written. Where a
feature is missing or partial, the page states the limit instead of
implying full support. Historical benchmarks carry the release they
came from.
Two site files change with the content. The architecture diagrams
described the old write path and a header layout that no longer
matches the wire format. The Web UI screenshot shows the current
interface.
Each area lands as its own commit, so a wrong correction is easy to
revert on its own.