Skip to content

docs: align v0.30.0 READMEs, compatibility and benchmark claims with implementation - #116

Merged
sahenjp merged 14 commits into
mainfrom
docs/align-readmes-current-030-20261106
Nov 6, 2026
Merged

sahenjp merged 14 commits into
mainfrom
docs/align-readmes-current-030-20261106

Conversation

@sahenjp

@sahenjp sahenjp commented Nov 6, 2026

Copy link
Copy Markdown
Owner

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 wiki command could build a Wikipedia index.

Changes

  • Update English, Japanese and Korean READMEs: current Standard/Clean/Full semantics, explicit network exceptions to offline search, strict HTTP engine-name validation, MCP tokenizer-specific structuredContent budgets and their limits, practical minimal custom-config example.
  • Replace misleading headline results from the 2026-11-04 profiles with clearly dated 2026-11-05 Standard and offline Clean observations, including the measured decline in Standard coverage. Mark these as historical, dataset-dependent observations, not a v0.30.0 run or evidence of superiority over Exa.
  • Fix Clean profile docs: Wikipedia dump command is rustxng-wikidump, not rustxng-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.
  • Update provider terms and issue-resolution docs to remove the retired --profile api instructions and distinguish Full's opt-in, terms-sensitive providers from reviewed Standard.
  • Correct old 170-enabled-engine / 100%-operational-parity and database-stub claims in compatibility/coverage docs; update Rust profile comments.
  • Refresh SECURITY to distinguish old RustSec snapshots from the current empty baseline and lockfile; remove a proxy comment implying it should bypass blocked search engines.
  • Add docs consistency regressions and an explicit historical notice to the 2026-11-04 comparison.

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

  • No new live benchmark, legal opinion, or claim that individual provider contracts automatically permit all commercial or redistributed use.
  • No changes to default engine selection, search ranking, API schemas, dependency versions or released v0.30.0 tag.

@sahenjp
sahenjp merged commit 52b92c4 into main Nov 6, 2026
14 checks passed
@sahenjp
sahenjp deleted the docs/align-readmes-current-030-20261106 branch November 6, 2026 03:30
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