Skip to content

feat: source cli command docs from nuxt/cli - #2392

Merged
danielroe merged 1 commit into
mainfrom
feat/cli-docs-source
Aug 23, 2026
Merged

feat: source cli command docs from nuxt/cli#2392
danielroe merged 1 commit into
mainfrom
feat/cli-docs-source

Conversation

@danielroe

@danielroe danielroe commented Aug 23, 2026

Copy link
Copy Markdown
Member

🔗 Linked issue

📚 Description

follow-up on nuxt/cli#1465 - this allows us to have versioned docs for nuxt/cli, and for those docs to live in that repo as the source of truth

@danielroe
danielroe requested a review from atinux as a code owner August 23, 2026 20:08
@vercel

vercel Bot commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nuxt Ready Ready Preview Aug 23, 2026 8:11pm

Request Review

@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 926e2c2e-2ba0-41ed-a295-d89028eba115

📥 Commits

Reviewing files that changed from the base of the PR and between a38a8bd and 94084af.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • app/components/DocsProseImg.vue
  • app/pages/docs/[...slug].vue
  • content.config.ts
  • nuxt.config.ts
  • patches/@nuxt__content.patch
  • pnpm-workspace.yaml
  • shared/utils/cli-docs.ts

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The change adds CLI documentation sources for Nuxt 3, 4, and 5. It defines shared repository and ref constants, adds ref-specific content checkout paths, and registers the @nuxt/content patch. Documentation preprocessing now rewrites CLI image and v3 link URLs. CLI API redirects target overview. Markdown images use a typed component that can bypass IPX for CLI SVG assets.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Merge Risk: ⚪ Minimal · up to 94084

The change sources Nuxt CLI documentation from its versioned repository, and no concrete correctness, deployment, or runtime risk remains; it is merge-ready after normal checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring check was indeterminate for this PR — some files could not be analyzed in time. Not blocking.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description explains that CLI documentation now comes from nuxt/cli and provides versioned documentation examples.
Title check ✅ Passed The title clearly and concisely describes sourcing CLI command documentation from nuxt/cli.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/cli-docs-source

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.

@nuxt-com-bundle-report

Copy link
Copy Markdown

Production bundle

Comparing a38a8bdc with 94084af8. Compressed sizes are calculated from the emitted production assets.

Metric Base (Brotli) PR (Brotli) Δ Brotli Δ gzip
Client JavaScript 2.49 MiB 2.49 MiB +17 B (+0.0%) +202 B (+0.0%)
Client CSS 30.1 KiB 30.1 KiB
Other client assets 339.3 KiB 339.3 KiB -7 B (-0.0%) +2 B (+0.0%)
Total client assets 2.85 MiB 2.85 MiB +10 B (+0.0%) +204 B (+0.0%)

Largest module increases

Module Base (Brotli) PR (Brotli) Δ Brotli
/app/components/DocsProseImg.vue?vue&type=script&setup=true&lang.ts 0 B 426 B +426 B
node_modules/@nuxt/image/dist/runtime/providers/none.js 0 B 203 B +203 B
/app/pages/docs/async-data-chunk-5.js 0 B 181 B +181 B
/app/pages/docs/async-data-chunk-4.js 0 B 168 B +168 B
/app/pages/docs/[version]/errors/async-data-chunk-22.js 0 B 155 B +155 B
/app/composables/async-data-chunk-32.js 106 B 257 B +151 B (+142.5%)
/app/pages/blog/async-data-chunk-14.js 0 B 144 B +144 B
/app/pages/deploy/async-data-chunk-8.js 0 B 134 B +134 B
/app/pages/blog/async-data-chunk-23.js 0 B 126 B +126 B
/app/pages/async-data-chunk-0.js 0 B 125 B +125 B

Module values come from Nuxt’s analyzer and are attribution estimates. This workflow is currently report-only.

Workflow run

@danielroe
danielroe merged commit 332e06d into main Aug 23, 2026
18 checks passed
@danielroe
danielroe deleted the feat/cli-docs-source branch August 23, 2026 21:21
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