Skip to content

docs: replace dead Vue Router docs links #32779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 28, 2025
Merged

docs: replace dead Vue Router docs links #32779

merged 1 commit into from
Jul 28, 2025

Conversation

dgxo
Copy link
Contributor

@dgxo dgxo commented Jul 27, 2025

🔗 Linked issue

Closes #32778

📚 Description

Fixes incorrect Vue Router docs and comment links, e.g.:
https://router.vuejs.org/api/#onBeforeRouteUpdate (just shows API overview) -> https://router.vuejs.org/api/functions/onBeforeRouteUpdate.html

@dgxo dgxo requested a review from danielroe as a code owner July 27, 2025 11:12
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@dgxo dgxo changed the title docs: Replace dead Vue Router docs links docs: replace dead Vue Router docs links Jul 27, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 27, 2025

Walkthrough

This set of changes updates several documentation files and code comments to use more precise and specific URLs pointing to the official Vue Router documentation. The updates replace general API anchor links with direct links to relevant type aliases, interfaces, or function documentation pages. No changes were made to the code logic, exported entities, or functional behaviour in any of the affected files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 c2c18e7 and e693f77.

📒 Files selected for processing (7)
  • docs/3.api/1.components/4.nuxt-link.md (1 hunks)
  • docs/3.api/2.composables/use-route.md (1 hunks)
  • docs/3.api/3.utils/define-nuxt-route-middleware.md (1 hunks)
  • docs/3.api/3.utils/on-before-route-leave.md (1 hunks)
  • docs/3.api/3.utils/on-before-route-update.md (1 hunks)
  • packages/nuxt/src/app/components/nuxt-link.ts (1 hunks)
  • packages/nuxt/src/pages/runtime/router.options.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

  • packages/nuxt/src/pages/runtime/router.options.ts
  • packages/nuxt/src/app/components/nuxt-link.ts
🧠 Learnings (7)
📓 Common learnings 
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: 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.
packages/nuxt/src/pages/runtime/router.options.ts (2)

Learnt from: huang-julien
PR: #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:

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.

Learnt from: GalacticHypernova
PR: #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.

docs/3.api/1.components/4.nuxt-link.md (2)

Learnt from: huang-julien
PR: #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:

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.

Learnt from: GalacticHypernova
PR: #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.

docs/3.api/3.utils/define-nuxt-route-middleware.md (2)

Learnt from: huang-julien
PR: #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:

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.

Learnt from: GalacticHypernova
PR: #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.

docs/3.api/3.utils/on-before-route-update.md (1)

Learnt from: huang-julien
PR: #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:

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.

packages/nuxt/src/app/components/nuxt-link.ts (3)

Learnt from: huang-julien
PR: #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:

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.

Learnt from: GalacticHypernova
PR: #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: TheAlexLichter
PR: #31812
File: packages/nuxt/src/components/plugins/islands-transform.ts:202-202
Timestamp: 2025-04-18T18:33:41.753Z
Learning: In Nuxt, using rolldownVersion (not rollupVersion) is intentional when detecting if rolldown-vite is being used, even though TypeScript may show an error because the property isn't in standard type definitions yet.

docs/3.api/2.composables/use-route.md (2)

Learnt from: huang-julien
PR: #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:

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.

Learnt from: GalacticHypernova
PR: #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.

🪛 LanguageTool
docs/3.api/1.components/4.nuxt-link.md

[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...interfaces/RouterLinkProps.html) - to: Any URL or a [route location object](ht...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ 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: code
  • GitHub Check: build
  • GitHub Check: lint-docs
🔇 Additional comments (7)
packages/nuxt/src/pages/runtime/router.options.ts (1)

11-11: Reference link now targets precise interface – looks good

Switching from the generic anchor to the dedicated RouterOptions page improves resilience against future doc-site anchor changes.

docs/3.api/1.components/4.nuxt-link.md (1)

229-229: Updated RouteLocation link is accurate

The link now resolves directly to the Vue Router type-alias page, eliminating the prior redirect and reducing 404 risk.

docs/3.api/2.composables/use-route.md (1)

52-52: Corrected RouteLocationNormalizedLoaded link

Good catch—pointing to the specific type-alias page clarifies the “read more” reference for readers.

docs/3.api/3.utils/on-before-route-leave.md (1)

11-11: Function doc URL fixed

The link now lands on the exact onBeforeRouteLeave function docs instead of the broad API page.

docs/3.api/3.utils/on-before-route-update.md (1)

11-11: Function doc URL fixed

Consistent with the other updates, this points straight to onBeforeRouteUpdate.html.

packages/nuxt/src/app/components/nuxt-link.ts (1)

474-474: Link updated – please confirm anchor validity

The comment now points to
https://router.vuejs.org/api/interfaces/RouterLinkProps.html#custom-.
Some typed-doc generators include the trailing hyphen, others don’t. Please open the link once to ensure it resolves; otherwise drop the trailing -. No runtime impact.

docs/3.api/3.utils/define-nuxt-route-middleware.md (1)

31-31: Targeted Vue-Router doc link looks good

The link now jumps straight to the RouteLocationNormalized type-alias page, improving accuracy.

✨ 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 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 pkg.pr.new
Copy link

pkg-pr-new bot commented Jul 27, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: e693f77

@dgxo
Copy link
Contributor Author

dgxo commented Jul 27, 2025

image is lychee okay?

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Jul 27, 2025

CodSpeed Performance Report

Merging #32779 will not alter performance

Comparing dgxo:patch-vue-router-links (e693f77) with main (c2c18e7)

Summary

✅ 10 untouched benchmarks

@dgxo dgxo mentioned this pull request Jul 27, 2025
Closed
danielroe
danielroe approved these changes Jul 28, 2025
View reviewed changes
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

thank you ❤️

@danielroe danielroe merged commit 1e19419 into nuxt:main Jul 28, 2025
47 of 51 checks passed
@github-actions github-actions bot mentioned this pull request Jul 28, 2025
Merged
danielroe pushed a commit that referenced this pull request Jul 28, 2025
@dgxo @danielroe
docs: replace dead Vue Router docs links (#32779)
d1665b7
@github-actions github-actions bot mentioned this pull request Jul 28, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
4.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs have incorrect vue router links
2 participants
@dgxo @danielroe