docs(guides): add create-prisma quick start to framework guides#7787
docs(guides): add create-prisma quick start to framework guides#7787AmanVarshney01 wants to merge 5 commits intomainfrom
Conversation
Adds a ## Quick start section at the top of each framework guide and the guides index, so users can scaffold a working project in one command with npx create-prisma@latest --template <framework>. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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 (1)
WalkthroughAdded "Quick start" sections to eight framework guides and the guides index that introduce a one-command scaffolding workflow ( Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
🍈 Lychee Link Check Report80 links: ❌ Errors
Full Statistics Table
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
There was a problem hiding this comment.
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 `@apps/docs/content/docs/guides/index.mdx`:
- Around line 19-20: Update the cspell configuration to whitelist the seven
missing framework identifiers by adding "next", "hono", "svelte", "astro",
"nuxt", "tanstack-start", and "nestjs" to the words array in the cspell.json
file (ensure they are added as separate entries in the existing words list so
spellcheck no longer flags these framework names).
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 23e10f51-fc80-4cc3-a008-3953ef753f9f
📒 Files selected for processing (9)
apps/docs/content/docs/guides/frameworks/astro.mdxapps/docs/content/docs/guides/frameworks/elysia.mdxapps/docs/content/docs/guides/frameworks/hono.mdxapps/docs/content/docs/guides/frameworks/nestjs.mdxapps/docs/content/docs/guides/frameworks/nextjs.mdxapps/docs/content/docs/guides/frameworks/nuxt.mdxapps/docs/content/docs/guides/frameworks/sveltekit.mdxapps/docs/content/docs/guides/frameworks/tanstack-start.mdxapps/docs/content/docs/guides/index.mdx
| Pick your framework and options from the prompts. To skip prompts use `--yes`, to set a framework upfront use `--template` (`next`, `hono`, `svelte`, `astro`, `nuxt`, `tanstack-start`, `nestjs`, `elysia`, `turborepo`). | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
cd apps/docs
# Reproduce exactly for the changed guides and show offending words with context
cspell \
"content/docs/guides/index.mdx" \
"content/docs/guides/frameworks/elysia.mdx" \
"content/docs/guides/frameworks/nextjs.mdx" \
"content/docs/guides/frameworks/nuxt.mdx" \
"content/docs/guides/frameworks/astro.mdx" \
"content/docs/guides/frameworks/sveltekit.mdx" \
"content/docs/guides/frameworks/hono.mdx" \
"content/docs/guides/frameworks/tanstack-start.mdx" \
--show-contextRepository: prisma/web
Length of output: 100
🏁 Script executed:
# Find cspell configuration
find . -name ".cspellrc*" -o -name "cspell.json" -o -name "cspell.config.*" 2>/dev/null | head -20Repository: prisma/web
Length of output: 77
🏁 Script executed:
# Read the specific file mentioned in the review
cat -n apps/docs/content/docs/guides/index.mdx | head -30Repository: prisma/web
Length of output: 1291
🏁 Script executed:
# Check the other framework files for context
ls -la apps/docs/content/docs/guides/frameworks/ 2>/dev/null || echo "frameworks directory not found"Repository: prisma/web
Length of output: 870
🏁 Script executed:
# Read the cspell configuration
cat apps/docs/cspell.jsonRepository: prisma/web
Length of output: 5746
Add 7 framework names to the spellcheck word list.
The cspell.json configuration is missing these framework names used on line 19: next, hono, svelte, astro, nuxt, tanstack-start, and nestjs. (Note: elysia and turborepo are already whitelisted.) Add these to the words array in apps/docs/cspell.json to resolve the spellcheck failures. These are legitimate framework identifiers that belong in the documentation dictionary.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/docs/content/docs/guides/index.mdx` around lines 19 - 20, Update the
cspell configuration to whitelist the seven missing framework identifiers by
adding "next", "hono", "svelte", "astro", "nuxt", "tanstack-start", and "nestjs"
to the words array in the cspell.json file (ensure they are added as separate
entries in the existing words list so spellcheck no longer flags these framework
names).
Switches quick start code blocks from bash to npm so the docs auto-generate pnpm/yarn/bun equivalents. Updates commands to npm create prisma@latest --template <framework>. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
npm passes args before -- to itself; the -- is required for --template to reach create-prisma correctly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…e managers Bypass npm-to-yarn for `npm create X@latest` since the library strips @latest and handles the -- separator inconsistently. Now produces: - pnpm: pnpm create prisma@latest --template <x> - yarn: yarn create prisma@latest --template <x> - bun: bun create prisma@latest --template <x> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
## Quick startsection to the guides index and all 8 framework guides (Next.js, Hono, SvelteKit, Astro, Nuxt, TanStack Start, NestJS, Elysia)npx create-prisma@latest --template <framework>one-liner so users can scaffold a ready-to-run project instantly--yesand--templateflagsTest plan
npx create-prisma@latest --template <framework>commands match available templates🤖 Generated with Claude Code
Summary by CodeRabbit