Repository navigation
docs: sync Starlight pages to the 0.3 crate API - #25
Merged
Merged
Conversation
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
approved these changes
Oct 12, 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
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.
Summary
All 20 Starlight pages under
web/src/content/docs/docs/were audited against the current crate source (crates/**, crateCargo.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
use_query(key, cache_policy, request_policy, fetcher, cx)and bareuse_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)display_data(),placeholder_data()/initial_data()and their settersQueryDiagnostic/ClientDiagnosticwith almost entirely wrong fields, so every example on it failed to compileuse_query_with_policy/fetch_query_with_policyand(persist)markers on three rows, and the serializer registry was described as(T, E)-keyed when it is keyed onTaloneCancelledvs superseded requests, observer re-render conditions (status or data-epoch change, not any state change),is_page_data_valid()false cases missingLoadingEmpty,on_errorfiring on cancel/reset/drop and not only after exhausted retries, andForcemode only applying to a fetch fromIdleVerification
bun run buildinweb/(og images, astro build, pagefind,llms.txt, page alternates) passes on this branchpath:lineand sourcepath:lineevidence and was reproduced by a second checker before fixingAlso updates
PERSIST_VERSION1 to 2 inskills/gpui-query-extensions/SKILL.mdto matchclient/persist.rs, and addsout/+mutants.out/to.gitignore.