docs(start): document route and asset base paths #7882
Openwhizzkid1452(GitHub profile, opens in a new tab)wants to merge 2 commits into
main fromrefs/pull/7882/headopened - @@ -0,0 +26,21 @@26+ base: '/app/',27+ plugins: [28+ tanstackStart({29+ router: {30+ basepath: '/app',31+ },32+ }),33+ viteReact(),34+ ],35+})36+```37+38+This configuration produces URLs with the following responsibilities:39+40+| URL | Prefix source |41+| -------------------- | -------------------------------------- |42+| `/app/about` | `router.basepath` |43+| `/app/_serverFn/...` | `router.basepath` and `serverFns.base` |44+| `/app/assets/...` | Vite `base` |45+46+If you omit `router.basepath`, Start derives it from a path-based Vite `base`. Setting both explicitly can make the deployment contract easier to see.@@ -0,0 +1,2 @@1+---2+ref: docs/start/framework/react/guide/base-paths.md
whizzkid1452(GitHub profile, opens in a new tab) linked this to fix #4888
Sign in to join this conversation.
Navigate logical layers of code changes, visualize relationships, and explore their blast radius.
🧰 Additional context used
📚 Code guidelines (2)
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Advanced
Run ID:
25da2c43-3e84-458d-b422-5a07187ee3d9📥 Commits
Reviewing files that changed from the base of the PR and between ec92b3a4cc55e19705cf49c123fbadd35c08f984 and f1e43d59e9de89fe5c551319f80d78de53165a77.
📒 Files selected for processing (2)
docs/start/framework/react/guide/base-paths.mddocs/start/framework/solid/guide/base-paths.md🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.
📝 Walkthrough
Walkthrough#
Adds React and Solid guides for configuring asset and route prefixes. Adds navigation links to both guides.
Changes#
Base Paths Documentation
docs/start/framework/react/guide/base-paths.md,docs/start/framework/solid/guide/base-paths.mddocs/start/config.jsonPriority: ➖ Normal
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other · Severity of issue fixed: Medium
Merge Risk: ⚪ Minimal · up to
f1e43The guides’ navigation and documented base-path behavior align with the runtime; no concrete merge risk is established.
Architecture Summary#
Architecture risk: 🔵 Low · up to
f1e43The change affects 1 system.
Changed systems:
docsArchitecture concerns No architecture-level concerns identified.
Review details
Systems and components
Before / after behavior
toURL) into the react “Server & Execution” sections list directly after “Routing” and before “Execution Model”.toURL) into the solid “Server & Execution” sections list directly after “Routing” and before “Execution Model”.basesets asset URLs whilerouter.basepathsets application-route URLs, and both should be configured invite.config.ts. Examples show matching/app/and/appprefixes, where the defaultserverFns.baseof/_serverFncombines with the router base, and root routes with assets under/_ui/. The guide also describes inferred router base paths, development and production request handling, and checks for direct requests, client navigation, asset URLs, and nested-route forwarding./app/configuration. It distinguishes Vite asset URLs from Start route URLs, explains that server-function URLs combinerouter.basepathwith the defaultserverFns.baseof/_serverFn, and describes deriving the router base from a path-based Vite base and forwarding requests in production.🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
#4888states that the solution requires Vitebaseand that the issue remains open until this behavior is documented. The React and Solid Start guides document the distinction between Vite `bas…#4888. The evidence sho…✨ Finishing Touches
🧪 Generate unit tests (beta)
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