Skip to content

docs: update Nitro instructions for v3 beta#6896

Open
dotnize wants to merge 3 commits intoTanStack:mainfrom
dotnize:docs/nitro-v3-beta
Open

docs: update Nitro instructions for v3 beta#6896
dotnize wants to merge 3 commits intoTanStack:mainfrom
dotnize:docs/nitro-v3-beta

Conversation

@dotnize
Copy link
Contributor

@dotnize dotnize commented Mar 11, 2026

Summary by CodeRabbit

  • Documentation
    • Updated React and Solid hosting guides with current Nitro links and a simplified installation flow (use standard npm install).
    • Added clear, step-by-step Nitro setup instructions and a concrete example showing how to enable Nitro in the Vite plugin configuration.
    • Removed references to nightly packages and clarified formatting for easier onboarding.

@changeset-bot
Copy link

changeset-bot bot commented Mar 11, 2026

⚠️ No Changeset found

Latest commit: c1864ed

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

Updated React and Solid hosting guides: replaced Nitro URL to nitro.build, switched to installing Nitro via npm install nitro, and added an example showing the nitro/vite plugin added to vite.config.ts alongside framework plugins.

Changes

Cohort / File(s) Summary
Hosting Guide Documentation Updates
docs/start/framework/react/guide/hosting.md, docs/start/framework/solid/guide/hosting.md
Replaced Nitro URL v3.nitro.buildnitro.build; removed nightly install instruction and replaced with npm install nitro; added step and example to register the nitro/vite plugin in vite.config.ts (showing nitro() alongside framework Vite plugins).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through lines and changed a link,
Swapped nightly steps for a simpler sync,
nitro.build now in the chain I sing,
Add nitro() to Vite — hear the plugins spring,
A tiny hop, a tidy doc-fling 🥕

🚥 Pre-merge checks | ✅ 3
✅ 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 clearly describes the main change: updating documentation for Nitro instructions, specifically mentioning the v3 beta update. This accurately reflects the content changes shown in both the React and Solid framework hosting guides.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@nx-cloud
Copy link

nx-cloud bot commented Mar 11, 2026

View your CI Pipeline Execution ↗ for commit c1864ed

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 4s View ↗
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-11 21:18:14 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 11, 2026

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@6896

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@6896

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@6896

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/@tanstack/nitro-v2-vite-plugin@6896

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@6896

@tanstack/react-router-devtools

npm i https://pkg.pr.new/@tanstack/react-router-devtools@6896

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/@tanstack/react-router-ssr-query@6896

@tanstack/react-start

npm i https://pkg.pr.new/@tanstack/react-start@6896

@tanstack/react-start-client

npm i https://pkg.pr.new/@tanstack/react-start-client@6896

@tanstack/react-start-server

npm i https://pkg.pr.new/@tanstack/react-start-server@6896

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@6896

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@6896

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@6896

@tanstack/router-devtools-core

npm i https://pkg.pr.new/@tanstack/router-devtools-core@6896

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@6896

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@6896

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/@tanstack/router-ssr-query-core@6896

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@6896

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@6896

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@6896

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/@tanstack/solid-router-devtools@6896

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/@tanstack/solid-router-ssr-query@6896

@tanstack/solid-start

npm i https://pkg.pr.new/@tanstack/solid-start@6896

@tanstack/solid-start-client

npm i https://pkg.pr.new/@tanstack/solid-start-client@6896

@tanstack/solid-start-server

npm i https://pkg.pr.new/@tanstack/solid-start-server@6896

@tanstack/start-client-core

npm i https://pkg.pr.new/@tanstack/start-client-core@6896

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/@tanstack/start-fn-stubs@6896

@tanstack/start-plugin-core

npm i https://pkg.pr.new/@tanstack/start-plugin-core@6896

@tanstack/start-server-core

npm i https://pkg.pr.new/@tanstack/start-server-core@6896

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/@tanstack/start-static-server-functions@6896

@tanstack/start-storage-context

npm i https://pkg.pr.new/@tanstack/start-storage-context@6896

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@6896

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@6896

@tanstack/vue-router

npm i https://pkg.pr.new/@tanstack/vue-router@6896

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/@tanstack/vue-router-devtools@6896

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/@tanstack/vue-router-ssr-query@6896

@tanstack/vue-start

npm i https://pkg.pr.new/@tanstack/vue-start@6896

@tanstack/vue-start-client

npm i https://pkg.pr.new/@tanstack/vue-start-client@6896

@tanstack/vue-start-server

npm i https://pkg.pr.new/@tanstack/vue-start-server@6896

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@6896

commit: 7819a6d

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/start/framework/react/guide/hosting.md`:
- Around line 222-226: The docs currently instruct installing Nitro as a regular
dependency; change the guidance to install Nitro as a devDependency because
`nitro/vite` is only used as a build-time plugin in `vite.config.ts` and not
needed at runtime—replace the install command `npm install nitro` with the dev
install `npm install -D nitro` and update any related prose to reflect that
Nitro is a build-time/dev dependency only.

In `@docs/start/framework/solid/guide/hosting.md`:
- Around line 216-220: The documentation currently instructs readers to run "npm
install nitro" which installs Nitro as a production dependency; update the
command to install it as a devDependency instead (for example change to "npm
install -D nitro" or "npm install --save-dev nitro"). Locate the install step in
the guide where the current code block shows "npm install nitro" and replace it
with the devDependency form so the docs correctly reflect that Nitro is only
required at build time.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: adbb4a04-2253-4984-ad85-afbd66317481

📥 Commits

Reviewing files that changed from the base of the PR and between 986776c and 118f599.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/hosting.md
  • docs/start/framework/solid/guide/hosting.md

@github-actions github-actions bot added the documentation Everything documentation related label Mar 11, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2026

Bundle Size Benchmarks

  • Commit: 9f2795a779aa
  • Measured at: 2026-03-11T21:18:31.836Z
  • Baseline source: history:9f2795a779aa
  • Dashboard: bundle-size history
Scenario Current (gzip) Delta vs baseline Raw Brotli Trend
react-router.minimal 87.09 KiB 0 B (0.00%) 274.11 KiB 75.68 KiB ▁▆▆████████
react-router.full 90.08 KiB 0 B (0.00%) 284.36 KiB 78.32 KiB ▁▃▃████████
solid-router.minimal 36.42 KiB 0 B (0.00%) 109.29 KiB 32.74 KiB ▁▅▅████████
solid-router.full 40.75 KiB 0 B (0.00%) 122.27 KiB 36.58 KiB ▁▅▅████████
vue-router.minimal 52.29 KiB 0 B (0.00%) 149.34 KiB 47.01 KiB ▁▅▅████████
vue-router.full 57.08 KiB 0 B (0.00%) 164.85 KiB 51.27 KiB ▁▅▅████████
react-start.minimal 99.66 KiB 0 B (0.00%) 313.26 KiB 86.22 KiB ▁▆▆████████
react-start.full 102.97 KiB 0 B (0.00%) 322.99 KiB 89.07 KiB ▁▄▄████████
solid-start.minimal 48.75 KiB 0 B (0.00%) 146.89 KiB 43.14 KiB ▁▄▄████████
solid-start.full 54.21 KiB 0 B (0.00%) 162.75 KiB 47.88 KiB ▁▅▅████████

Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better.

@codspeed-hq
Copy link

codspeed-hq bot commented Mar 11, 2026

Merging this PR will not alter performance

✅ 6 untouched benchmarks


Comparing dotnize:docs/nitro-v3-beta (c1864ed) with main (9f2795a)

Open in CodSpeed

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/start/framework/solid/guide/hosting.md (1)

224-234: ⚠️ Potential issue | 🟡 Minor

Align plugin order with the working example.

The plugin order in this documentation differs from the proven working example. The working example in examples/solid/start-basic/vite.config.ts places nitro() at the end of the plugins array, after viteSolid({ ssr: true }), but the documentation shows nitro() placed before viteSolid().

Update the plugin order to:

plugins: [tanstackStart(), viteSolid({ ssr: true }), nitro()],
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/start/framework/solid/guide/hosting.md` around lines 224 - 234, The
plugins array in the Vite config places nitro() before viteSolid({ ssr: true });
update the export default defineConfig plugins order so it matches the working
example by moving nitro() after viteSolid({ ssr: true })—i.e., ensure plugins:
[tanstackStart(), viteSolid({ ssr: true }), nitro()] in the defineConfig block
(refer to tanstackStart, viteSolid, nitro, and the plugins array to locate the
change).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/start/framework/solid/guide/hosting.md`:
- Around line 224-234: The plugins array in the Vite config places nitro()
before viteSolid({ ssr: true }); update the export default defineConfig plugins
order so it matches the working example by moving nitro() after viteSolid({ ssr:
true })—i.e., ensure plugins: [tanstackStart(), viteSolid({ ssr: true }),
nitro()] in the defineConfig block (refer to tanstackStart, viteSolid, nitro,
and the plugins array to locate the change).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 031aacf5-977a-4307-b00a-b26c82a46818

📥 Commits

Reviewing files that changed from the base of the PR and between 3d74f42 and c1864ed.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/hosting.md
  • docs/start/framework/solid/guide/hosting.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/start/framework/react/guide/hosting.md

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