Skip to content

Improve installation remarks regarding pnpm#3775

Open
jtheisen wants to merge 2 commits intonuxt:mainfrom
jtheisen:patch-1
Open

Improve installation remarks regarding pnpm#3775
jtheisen wants to merge 2 commits intonuxt:mainfrom
jtheisen:patch-1

Conversation

@jtheisen
Copy link
Copy Markdown

Added instructions for rebuilding better-sqlite3 after installation.

(just docs)

Added instructions for rebuilding better-sqlite3 after installation.
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 24, 2026

@jtheisen is attempting to deploy a commit to the Nuxt Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e850c41d-a9f4-4393-a0bb-c17a7de3de35

📥 Commits

Reviewing files that changed from the base of the PR and between 1b0b12e and d4dd007.

📒 Files selected for processing (1)
  • docs/content/docs/1.getting-started/2.installation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/content/docs/1.getting-started/2.installation.md

📝 Walkthrough

Walkthrough

This pull request updates the installation documentation to add fallback troubleshooting steps for pnpm users when native builds are not triggered during dependency installation. It instructs users to approve pnpm build scripts or, if that doesn't work, to clear node_modules or run an explicit pnpm rebuild for better-sqlite3 and sqlite3, and includes a code example demonstrating the rebuild command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—improving pnpm-related installation documentation with fallback rebuild instructions.
Description check ✅ Passed The description is related to the changeset, clearly noting the docs-only nature and mentioning the better-sqlite3 rebuild instructions added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown

@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 `@docs/content/docs/1.getting-started/2.installation.md`:
- Around line 111-117: The instructions currently show only rebuilding
`better-sqlite3`, which can mislead users who selected `sqlite3`; update the
installation note to include an explicit rebuild example for `sqlite3` as well
(add a second code block running `pnpm rebuild sqlite3`) alongside the existing
`pnpm rebuild better-sqlite3` so both package options are covered in the docs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 920f3938-494e-4eeb-bb58-f4a1bd7db797

📥 Commits

Reviewing files that changed from the base of the PR and between 8aabefd and 1b0b12e.

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

Comment thread docs/content/docs/1.getting-started/2.installation.md
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 24, 2026

npm i https://pkg.pr.new/@nuxt/content@3775

commit: d4dd007

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