docs(docs): use package-manager-agnostic wording for Prisma CLI in quickstarts#7926
Conversation
…ickstarts The quickstart 'Initialize Prisma ORM' step said 'invoke the Prisma CLI by prefixing it with npx', but the code block below it renders package-manager tabs (npm/pnpm/yarn/bun) via remarkNpmOptions. For the pnpm/yarn/bun tabs the command is 'pnpm dlx prisma' / 'yarn dlx prisma' / 'bunx --bun prisma', so the npx-specific prose is incorrect for 3 of the 4 tabs. Reword to be neutral. Linear: N/A (external community contribution) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@morgan-coded is attempting to deploy a commit to the Prisma Team on Vercel. A member of the Team first needs to authorize it. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
WalkthroughThis PR updates Prisma quickstart documentation across eight database-specific guides to replace npm-centric CLI invocation wording with package-manager-agnostic language. Each guide's "Initialize Prisma ORM" step now instructs users they can run Prisma CLI commands via their package manager, making the guidance consistent across npm, pnpm, yarn, and bun tabs. ChangesQuickstart CLI Instructions
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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. Comment |
What
The "Initialize Prisma ORM" step in the quickstart guides says:
…directly above a code block that renders package-manager tabs (npm / pnpm /
yarn / bun). For the non-npm tabs the rendered command is
pnpm dlx prisma,yarn dlx prisma, andbunx --bun prisma, so the "prefix it withnpx"wording is npm-specific and incorrect for 3 of the 4 tabs.
The tabs come from
apps/docs/source.config.ts(remarkNpmOptions), which runsevery npm code block through
npm-to-yarn.Change
Reword the intro sentence to be package-manager-neutral on all 8 quickstart
pages that have it:
The tabbed code block already adapts the command per package manager, so the
prose no longer needs to name
npx.Pages updated: postgresql, prisma-postgres, mysql, sqlite, sql-server,
cockroachdb, planetscale, mongodb.
Testing
pnpm run lint:spellcheck— passes (prose-only change, all words valid).Closes #7913
Summary by CodeRabbit