docs: update Nitro instructions for v3 beta#6896
docs: update Nitro instructions for v3 beta#6896dotnize wants to merge 3 commits intoTanStack:mainfrom
Conversation
|
📝 WalkthroughWalkthroughUpdated React and Solid hosting guides: replaced Nitro URL to nitro.build, switched to installing Nitro via Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Comment |
|
View your CI Pipeline Execution ↗ for commit c1864ed
☁️ Nx Cloud last updated this comment at |
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/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
📒 Files selected for processing (2)
docs/start/framework/react/guide/hosting.mddocs/start/framework/solid/guide/hosting.md
Bundle Size Benchmarks
Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better. |
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
There was a problem hiding this comment.
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 | 🟡 MinorAlign 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.tsplacesnitro()at the end of the plugins array, afterviteSolid({ ssr: true }), but the documentation showsnitro()placed beforeviteSolid().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
📒 Files selected for processing (2)
docs/start/framework/react/guide/hosting.mddocs/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
Summary by CodeRabbit