Skip to content

Conversation

@cameronapak
Copy link
Contributor

@cameronapak cameronapak commented Oct 8, 2025

Simple docs update to help people who are using TanStack Start have the right usage for the vite plugin.

Summary by CodeRabbit

  • Documentation
    • Updated SPA mode guide for React to use the correct public API name in code examples (TanStackStart → tanstackStart).
    • Ensures examples reflect current API usage for easier copy-paste and fewer implementation errors.
    • Improves clarity and consistency across the SPA configuration examples.

@github-actions github-actions bot added the documentation Everything documentation related label Oct 8, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 8, 2025

Walkthrough

Updates SPA mode documentation for React by renaming the public API call in two code examples from TanStackStart to tanstackStart. No structural or behavioral changes beyond the function name in the examples.

Changes

Cohort / File(s) Summary
Docs — SPA mode API rename
docs/start/framework/react/spa-mode.md
Renamed API calls in two code snippets from TanStackStart to tanstackStart, preserving existing SPA config structure and context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A nibble of docs, a hop through the start,
Lowercase magic, a tidy little part.
From TanStackStart to tanstackStart we glide,
Breadcrumbs of code where examples reside.
Thump-thump! says the rabbit—rename complete with pride. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly communicates that this pull request updates the Vite plugin usage documentation for TanStack Start, directly reflecting the changes made in the SPA mode docs without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0c63d4 and 8419d0d.

📒 Files selected for processing (1)
  • docs/start/framework/react/spa-mode.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/start/framework/react/spa-mode.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/start/framework/react/spa-mode.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@schiller-manuel schiller-manuel merged commit 5e33b74 into TanStack:main Oct 8, 2025
2 checks passed
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants