Docs: Add tanstack documentation#34639
Conversation
📝 WalkthroughWalkthroughAdds a large set of documentation snippets and a new guide page for the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/get-started/frameworks/tanstack-react.mdx`:
- Around line 23-31: Update the displayed minimum React requirement in the
GetStartedVersions prop data: replace the React entry's range value from '≥
16.8' to '≥ 18' (and update any accompanying copy if present) so it matches
TanStack Router prerequisites; ensure the React entry (name: 'React') and any
documentation text mention React 18+ (and ReactDOM 18+ with createRoot support)
to avoid misleading users.
- Around line 363-382: The Vite plugin sample uses the newer transform: {
filter, handler } syntax (requires Vite 6.3+) which breaks compatibility with
Vite ≥5; replace the object-form transform with the traditional transform(code,
id) function and perform the file-filtering inline (e.g., test id against
/\.server\.[mc]?[jt]sx?$/ and return null early if not matched or if id includes
'node_modules'), then run the same logic that parses named exports into names,
builds lines (using _noop/_proxy and export stubs) and returns { code:
lines.join('\n'), map: null }; update the plugin object (name:
'storybook:stub-server-files') to use this transform function so the example
works on older Vite versions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 395ee5f4-d86b-4e57-98d2-aa4f76dd05d4
📒 Files selected for processing (1)
docs/get-started/frameworks/tanstack-react.mdx
shilman
left a comment
There was a problem hiding this comment.
Great job @huang-julien !! Minor comments below
Co-authored-by: Copilot <copilot@github.com>
* next: (96 commits) Fix typo in the code sampel for "Fully Custom Args" for web-cmp refactor: move to job condition ci: skip label step if no output don't write versions json files anymore during publishing refactor: improve script feat: don't close community-flagged accounts, flag them update lock file fix: add optional react-dom type peers to next frameworks fix: add optional React type peers to published packages chore: start investigating missing react type peers Initial plan publish to next branch when triggered manually feedbacks ci: allow branch selection for sandbox generation fix(addons-docs): make docs context type match usage Build: Disable NX workflow triggers while license is expired Add missing vite peer dependency in vite-based frameworks CLI: Change mock event detection Ensure process termination on signal when telemetry is disabled Add story with changeDetection disabled ...
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
* next: (52 commits) Revert "fix run oxfmt after generating source files" fix run oxfmt after generating source files try catch git init in sandboxes Cleanup fix: init git for change detection on every dev task run Apply review feedback for change detection Move common logic into a shared util Only show Clear filters button if there are active filters Dedupe lock file Cleanup Fix E2E tests fix: scope change-detection git init to e2e-tests-dev task only fix: init git during sandbox generation so change detection works at startup fix: cleanup AI-slop in tests, drain patchQueue before OXC pool dispose yarn dedupe Show tooltip on status filters Prevent race condition between two filter operations Add clear filter button on sidebar empty state Enable change detection feature flag in E2E sandbox templates Enhance ChangeDetectionResolverFactory to support yarn workspace cross-package resolution and update documentation for related status icons ...
#34403
What I did
Add the documentation for the tanstack framework integration usage.
The documentation is split between tanstack router which is cleint-only and tanstack start which is the meta-framework.
Checklist for Contributors
Testing
Manual testing
N/A - Docs-only update
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit