docs: JSDoc @example coverage, new feature demos, docs depth pass - #29
Merged
Conversation
Implements docs/plan/11-docs-jsdoc-examples-overhaul.md: adds @example blocks to public exports and config fields (core + tanstack-query) with GitHub-linked @see references, adds example demos for previously undemonstrated features (concurrency queue, multi-tenancy, streaming, cache persistence, timeouts/cancellation, manual types, RPC rate limiting, environment switching, live codegen), and deepens six thin docs pages with source-verified worked examples. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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
@exampleblocks (+ GitHub-linked@see) to public exports and config fields acrosspackages/coreandpackages/tanstack-query, closing the biggest IDE-discoverability gap (JSDoc without runnable examples).examples/react-viteandexamples/nextjs.deduplication,environments,concurrency-queue,rpc-rate-limiting,retries,hooks-and-events) to match the depth ofcache-persistence.md/authentication.md, with every technical claim (pipeline order, backoff formula, queue ordering, rate-limit config, hook fields) verified against current source.docs/plan/11-docs-jsdoc-examples-overhaul.md(step + verify format).No runtime behavior changes — docs/JSDoc/examples only.
Test plan
pnpm buildclean, all packagespnpm typecheckclean, all packagespnpm testclean, all packages (incl. new react-vite test)node scripts/check-browser-bundle.mjscleandetectEnvironment()), streaming demo renders incrementally, codegen regen produces zero content drift