Skip to content

docs: sync Starlight pages to the 0.3 crate API - #25

Merged
hmziqrs merged 2 commits into
freeoxide:masterfrom
hmziqagent:docs/currency-audit
Oct 12, 2026
Merged

hmziqrs merged 2 commits into
freeoxide:masterfrom
hmziqagent:docs/currency-audit

Conversation

@hmziqagent

Copy link
Copy Markdown
Contributor

Summary

All 20 Starlight pages under web/src/content/docs/docs/ were audited against the current crate source (crates/**, crate Cargo.tomls, README, CHANGELOG) and brought back in sync. 80 stale claims were found; all 80 are fixed here.

The audit ran as a multi-agent pass: one blind auditor per docs section, every finding re-verified by an independent second checker that read the cited doc and source lines itself (0 of 80 failed that check), fixes applied per section, the site build gating each round, and fresh cold re-audits after each fix round.

What was wrong

  • Code samples that do not compile against 0.3: positional use_query(key, cache_policy, request_policy, fetcher, cx) and bare use_mutation(cx) calls, QueryClient::new(cache_policy, request_policy) (real form: new() + with_policies), client.force_fetch_query(...) (only exists in the excluded legacy crate)
  • Legacy-only APIs documented as current: display_data(), placeholder_data() / initial_data() and their setters
  • The DevTools page documented QueryDiagnostic / ClientDiagnostic with almost entirely wrong fields, so every example on it failed to compile
  • Wrong versions and missing surface: the skills page said the packs track v0.2.0 (they are on 0.3.0), the API reference omitted use_query_with_policy / fetch_query_with_policy and (persist) markers on three rows, and the serializer registry was described as (T, E)-keyed when it is keyed on T alone
  • Semantics: Cancelled vs superseded requests, observer re-render conditions (status or data-epoch change, not any state change), is_page_data_valid() false cases missing LoadingEmpty, on_error firing on cancel/reset/drop and not only after exhausted retries, and Force mode only applying to a fetch from Idle

Verification

  • bun run build in web/ (og images, astro build, pagefind, llms.txt, page alternates) passes on this branch
  • Every finding carries doc path:line and source path:line evidence and was reproduced by a second checker before fixing
  • Not covered: runtime behavior of documented APIs (no example was compiled or executed beyond the mdx build itself)

Also updates PERSIST_VERSION 1 to 2 in skills/gpui-query-extensions/SKILL.md to match client/persist.rs, and adds out/ + mutants.out/ to .gitignore.

Audit of all 20 pages under web/src/content/docs against the crate
source found samples calling removed or legacy-only apis (positional
use_query / use_mutation, QueryClient::new with policies,
force_fetch_query, display_data, placeholder/initial data accessors),
wrong devtools diagnostic fields, a stale skill-pack version, and
wrong defaults and semantics. Every claim was re-verified against the
source before fixing. Also corrects PERSIST_VERSION in the extensions
skill pack (1 -> 2, matching 0.3.0).
@hmziqrs
hmziqrs merged commit 06281f3 into freeoxide:master Oct 12, 2026
2 checks passed
@hmziqagent
hmziqagent deleted the docs/currency-audit branch October 12, 2026 00:58
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