docs: fix links to Nitro docs #32691

AloisSeckar · 2025-07-20T09:46:14Z

🔗 Linked issue

resolves #32690

📚 Description

Some of the links to nitro.build documentation don't work anymore, i.e. https://nitro.build/config/#routerules (the trailing slash is wrong).

The PR also updates a few other that do work, but only via redirects.

bolt-new-by-stackblitz · 2025-07-20T09:46:17Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-20T09:48:26Z

Walkthrough

This update consists of documentation and comment changes across several files, focusing on correcting and standardising URLs that reference Nitro configuration and deployment documentation. Adjustments include removing unnecessary slashes before hash fragments and at the end of URLs, as well as updating a deployment path to reflect the current Nitro documentation structure. These modifications appear in Markdown documentation, JSDoc comments, and code comments, with no alterations to code logic, exported entities, or functional behaviour.

📜 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 a07d7b9 and 939e79c.

📒 Files selected for processing (6)

docs/1.getting-started/15.prerendering.md (1 hunks)
docs/1.getting-started/16.deployment.md (1 hunks)
docs/1.getting-started/18.upgrade.md (1 hunks)
docs/3.api/6.nuxt-config.md (2 hunks)
packages/nuxt/src/core/external-config-files.ts (1 hunks)
packages/schema/src/types/schema.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

🧠 Learnings (5)

docs/1.getting-started/16.deployment.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

packages/nuxt/src/core/external-config-files.ts (3)

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

docs/1.getting-started/18.upgrade.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

docs/1.getting-started/15.prerendering.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

docs/3.api/6.nuxt-config.md (1)

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: build
GitHub Check: lint-docs
GitHub Check: code

🔇 Additional comments (8)

packages/schema/src/types/schema.ts (2)

1503-1506: Corrected JSDoc URL – looks good
Trailing slash removed; resolves to the correct Nitro docs fragment. No further action required.

1512-1515: Route-rules link fixed – thanks
The routeRules reference now points to a valid fragment. Everything else unchanged.

docs/1.getting-started/16.deployment.md (1)

63-66: Updated “read-more” link verified
The link now follows the new Nitro docs path (/deploy/runtimes/node). Good catch.

packages/nuxt/src/core/external-config-files.ts (1)

46-48: Inline comment URL updated – fine
The comment now matches canonical Nitro config URL. No code impact.

docs/1.getting-started/18.upgrade.md (1)

1157-1159: Slash before fragment removed – OK
Link renders correctly; rest of section untouched.

docs/1.getting-started/15.prerendering.md (1)

101-103: Fragment link tidy-up confirmed
routeRules documentation link now resolves without redirect. All good.

docs/3.api/6.nuxt-config.md (2)

1471-1471: Link fix looks good.

Updated URL removes the trailing slash which previously caused a 404. No further action needed.

1732-1732: Route-rules link corrected.

The fragment now resolves directly to the section without redirect; change is correct.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-07-20T09:50:03Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32691

nuxt

npm i https://pkg.pr.new/nuxt@32691

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32691

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32691

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32691

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32691

commit: 939e79c

codspeed-hq · 2025-07-20T10:01:37Z

CodSpeed Performance Report

Merging #32691 will not alter performance

_{Comparing AloisSeckar:nitro-docs (939e79c) with main (9193b32)¹}

Summary

✅ 10 untouched benchmarks

No successful run was found on main (a07d7b9) during the generation of this report, so 9193b32 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

danielroe

thank you ❤️

docs: fix links to Nitro docs

939e79c

AloisSeckar requested a review from danielroe as a code owner July 20, 2025 09:46

github-actions bot added 4.x documentation labels Jul 20, 2025

danielroe approved these changes Jul 20, 2025

View reviewed changes

danielroe merged commit f838490 into nuxt:main Jul 20, 2025
48 of 50 checks passed

This was referenced Jul 20, 2025

v4.0.1 #32641

Merged

v4.0.1 #32705

Closed

danielroe pushed a commit that referenced this pull request Jul 21, 2025

docs: fix links to Nitro docs (#32691)

c4a30d2

This was referenced Jul 21, 2025

v3.17.8 #32610

Closed

v3.18.0 #32713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: fix links to Nitro docs #32691

docs: fix links to Nitro docs #32691

Uh oh!

AloisSeckar commented Jul 20, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 20, 2025

Uh oh!

coderabbitai bot commented Jul 20, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 20, 2025

Uh oh!

codspeed-hq bot commented Jul 20, 2025

Uh oh!

danielroe left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

docs: fix links to Nitro docs #32691

docs: fix links to Nitro docs #32691

Uh oh!

Conversation

AloisSeckar commented Jul 20, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 20, 2025

Uh oh!

coderabbitai bot commented Jul 20, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 20, 2025

Uh oh!

codspeed-hq bot commented Jul 20, 2025

CodSpeed Performance Report

Merging #32691 will not alter performance

Summary

Footnotes

Uh oh!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)