Repository navigation
docs: align v0.30.0 READMEs, compatibility and benchmark claims with implementation - #116
Merged
Merged
Conversation
…OLUTION-2026-11-05.md
…RISON-2026-11-04.md)
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.
Why
Current v0.30.0 documentation mixed old profile behavior and old benchmark data with current defaults. Some passages claimed a removed API profile existed, that token limits were unavailable, that ~170 engines were default-enabled, and that an unimplemented
rustxng-index wikicommand could build a Wikipedia index.Changes
structuredContentbudgets and their limits, practical minimal custom-config example.rustxng-wikidump, notrustxng-index wiki; clarify that local search itself is offline but explicit page fetching can use the network; move the measurements interpretation into an appropriate section.--profile apiinstructions and distinguish Full's opt-in, terms-sensitive providers from reviewed Standard.Validation
The edits preserve raw benchmark records, implementation/endpoint settings and Release Please markers. CI should run existing Python docs tests, Markdown validation, and the project's standard tests. The only Rust change is documentation comments (no runtime behavior change).
Out of scope