Skip to content

docs(examples): fix nuxt3 README links and commands#10227

Open
grzdev wants to merge 2 commits intoTanStack:mainfrom
grzdev:docs/examples-nuxt3-readme-fixes
Open

docs(examples): fix nuxt3 README links and commands#10227
grzdev wants to merge 2 commits intoTanStack:mainfrom
grzdev:docs/examples-nuxt3-readme-fixes

Conversation

@grzdev
Copy link
Contributor

@grzdev grzdev commented Mar 4, 2026

🎯 Changes

What
Fixes outdated Nuxt documentation links and updates package manager commands in the examples/vue/nuxt3 README.

Why
The README referenced the old Nuxt documentation domain:

https://v3.nuxtjs.org

This domain now redirects and some pages (such as deployment docs) return a 404. Updating the links to the current Nuxt documentation ensures readers are directed to working resources.

The README also referenced yarn commands, while this repository uses pnpm (packageManager: pnpm@10.24.0). Updating the commands keeps the example consistent with the repo standard.

Changes

Scope
Docs-only change. No package/runtime changes.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated Nuxt documentation links to the current 3.x site (getting started and deployment pages).
    • Replaced yarn with pnpm in installation, development, and build commands for the example project.

@changeset-bot
Copy link

changeset-bot bot commented Mar 4, 2026

⚠️ No Changeset found

Latest commit: f07cda2

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 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: af8a3ca7-d53f-47e5-97a1-68a4a4804f12

📥 Commits

Reviewing files that changed from the base of the PR and between 5674722 and f07cda2.

📒 Files selected for processing (1)
  • examples/vue/nuxt3/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • examples/vue/nuxt3/README.md

📝 Walkthrough

Walkthrough

Updated the Nuxt3 example README: replaced v3.nuxtjs.org URLs with nuxt.com/docs/3.x/getting-started paths and changed package manager commands from yarn to pnpm for install, dev, and build instructions.

Changes

Cohort / File(s) Summary
Documentation Updates
examples/vue/nuxt3/README.md
Replaced Nuxt docs URLs from v3.nuxtjs.org to nuxt.com/docs/3.x/getting-started/ and swapped yarn commands for pnpm in install, dev, and build instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation

Poem

🐰 I hopped through docs with nimble feet,

Swapped links and commands to keep things neat,
From yarn to pnpm I made the switch,
Nuxt3 README now fits the pitch,
A little hop, a tidy tweak, so sweet.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(examples): fix nuxt3 README links and commands' accurately summarizes the main changes: updating documentation links and package manager commands in the Nuxt3 example README.
Description check ✅ Passed The description comprehensively covers all template sections with clear 'What', 'Why', and 'Changes' explanations, completed checklists, and correct release impact designation as docs-only.
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 4, 2026

View your CI Pipeline Execution ↗ for commit f07cda2

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

☁️ Nx Cloud last updated this comment at 2026-03-04 20:06:59 UTC

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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@examples/vue/nuxt3/README.md`:
- Line 3: Polish the README user-facing copy: change the sentence "We recommend
to look at the [documentation](...)" to "We recommend looking at the
[documentation](...)" and update the sentence "Check out the [Nuxt 3 docs](...)"
(or similar copy around the bottom of the file that currently reads "Check out
…") to "Check out …" with the corrected phrasing; locate and edit the existing
text strings in examples/vue/nuxt3/README.md so the two occurrences use "We
recommend looking at …" and "Check out …" respectively.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2a72d158-fe21-4d76-8932-3a2161ba6ed9

📥 Commits

Reviewing files that changed from the base of the PR and between fe25edc and 5674722.

📒 Files selected for processing (1)
  • examples/vue/nuxt3/README.md

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 4, 2026

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10227

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10227

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10227

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10227

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10227

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10227

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10227

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10227

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10227

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10227

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10227

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10227

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10227

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10227

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10227

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10227

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10227

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10227

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10227

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10227

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10227

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10227

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10227

commit: e266c63

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant