docs: make v0.2 deployment, architecture and API guidance accurate - #9
Merged
Merged
Conversation
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
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 described the in-memory partition path as production ingest, advertised unverified performance/GPU gains, and included incomplete setup and recovery examples. This update aligns the guides, API docs, protocol comments and operational examples with the persistent v0.2.0 implementation.
Validation: strict Rustdoc build, four doctests, Rust 1.98 Clippy, release-package verification, formatting, actionlint, shell/TOML/relative-link checks; executed the README library example, three-shard quick start, 60-record distributed example, and five-shard load-test recipe with 1,000,000 records acknowledged. Full regression suite passed: 357 tests, zero failures, one intentionally ignored timing diagnostic. PR CI passed all three jobs: MSRV, build/test/documentation/package/manifests, and production container image.
The engine and storage algorithms are unchanged. The published v0.2.0 tag and crate remain unchanged.