Skip to content

docs: add package resolution instructions for v4.0 opt-in#956

Merged
antfu merged 1 commit intomainfrom
antfu/docs-v4-opt-in-resolution
Mar 18, 2026
Merged

docs: add package resolution instructions for v4.0 opt-in#956
antfu merged 1 commit intomainfrom
antfu/docs-v4-opt-in-resolution

Conversation

@antfu
Copy link
Member

@antfu antfu commented Mar 18, 2026

Summary

  • Added comprehensive "Opting in to v4.0" section with package manager-specific instructions (npm, yarn, pnpm) for overriding the bundled DevTools with the v4 alpha version
  • Updated the "Nightly Release Channel" section to use the same resolution-based approach for consistency across all package managers

This clarifies how users can opt into the v4 alpha by using package manager resolutions/overrides instead of modifying devDependencies directly.

Add clear instructions for opting into v4.0 alpha using package manager resolutions (npm overrides, yarn resolutions, pnpm overrides). Also update the Nightly Release Channel section to use the same resolution-based approach for consistency.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages
Copy link

Deploying nuxt-devtools with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2b736a3
Status:🚫  Build failed.

View logs

@antfu antfu merged commit 1f6a712 into main Mar 18, 2026
3 of 5 checks passed
@antfu antfu deleted the antfu/docs-v4-opt-in-resolution branch March 18, 2026 06:04
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 18, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 70618b4a-5ee1-48ac-b556-07ef7ced0ea0

📥 Commits

Reviewing files that changed from the base of the PR and between 2b157fb and 2b736a3.

📒 Files selected for processing (2)
  • README.md
  • docs/content/1.guide/0.getting-started.md

📝 Walkthrough

Walkthrough

This pull request updates documentation files to provide guidance on accessing pre-release versions of Nuxt DevTools. A new "Opting in to v4.0" section is added to both README.md and the getting started guide, explaining how to override the bundled DevTools version via package manager resolutions. Configuration examples are provided for npm, yarn, and pnpm, including instructions to remove lockfiles and reinstall dependencies. The "Nightly Release Channel" section is also updated with similar resolution-based configuration examples, replacing previous guidance with explicit package manager override instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch antfu/docs-v4-opt-in-resolution
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can enforce grammar and style rules using `languagetool`.

Configure the reviews.tools.languagetool setting to enable/disable rules and categories. Refer to the LanguageTool Community to learn more.

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