Skip to content

docs(guides): add create-prisma quick start to framework guides#7787

Open
AmanVarshney01 wants to merge 5 commits intomainfrom
docs/create-prisma-quickstart
Open

docs(guides): add create-prisma quick start to framework guides#7787
AmanVarshney01 wants to merge 5 commits intomainfrom
docs/create-prisma-quickstart

Conversation

@AmanVarshney01
Copy link
Copy Markdown
Member

@AmanVarshney01 AmanVarshney01 commented Apr 8, 2026

Summary

  • Adds a ## Quick start section to the guides index and all 8 framework guides (Next.js, Hono, SvelteKit, Astro, Nuxt, TanStack Start, NestJS, Elysia)
  • Each section shows the npx create-prisma@latest --template <framework> one-liner so users can scaffold a ready-to-run project instantly
  • Guides index gets a short quick-start block with the interactive command + note on --yes and --template flags
  • Existing manual setup steps are untouched

Test plan

  • Verify quick start sections render correctly on each framework guide page
  • Confirm npx create-prisma@latest --template <framework> commands match available templates

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added “Quick start” sections to all framework guides, offering single-command scaffolding to create projects preconfigured for Prisma + Postgres.
    • Updated the guides index with quick-start instructions, template-selection guidance, and optional flags to skip prompts for faster project initialization.
    • Normalized displayed create-command examples across package managers for clearer usage.

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>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 8, 2026

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

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Apr 10, 2026 3:45pm
docs Ready Ready Preview, Comment Apr 10, 2026 3:45pm
eclipse Ready Ready Preview, Comment Apr 10, 2026 3:45pm
site Ready Ready Preview, Comment Apr 10, 2026 3:45pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 311735b6-183a-4247-82b6-6e3062fd6972

📥 Commits

Reviewing files that changed from the base of the PR and between 385dcd4 and a26b4ae.

📒 Files selected for processing (1)
  • apps/docs/source.config.ts

Walkthrough

Added "Quick start" sections to eight framework guides and the guides index that introduce a one-command scaffolding workflow (npm create prisma@latest -- --template <framework>) and updated docs build logic to convert that npm create pattern to equivalent pnpm, yarn, and bun create forms in source.config.ts.

Changes

Cohort / File(s) Summary
Framework guides - Quick start additions
apps/docs/content/docs/guides/frameworks/astro.mdx, apps/docs/content/docs/guides/frameworks/elysia.mdx, apps/docs/content/docs/guides/frameworks/hono.mdx, apps/docs/content/docs/guides/frameworks/nestjs.mdx, apps/docs/content/docs/guides/frameworks/nextjs.mdx, apps/docs/content/docs/guides/frameworks/nuxt.mdx, apps/docs/content/docs/guides/frameworks/sveltekit.mdx, apps/docs/content/docs/guides/frameworks/tanstack-start.mdx
Inserted a new top-of-guide "Quick start" paragraph offering a one-command scaffold (npm create prisma@latest -- --template <template>) and a pointer to follow existing manual setup steps.
Guides index - Quick start update
apps/docs/content/docs/guides/index.mdx
Replaced the prior intro with a "Quick start" block describing the base scaffold command (npm create prisma@latest), flags (--yes, --template) and supported templates.
Docs build conversion logic
apps/docs/source.config.ts
Updated convertLine to specially handle npm create <pkg>@latest patterns: extract <pkg>@latest and any -- trailing flags, normalize them, and emit equivalent pnpm create / yarn create / bun create forms while leaving other conversions unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding 'Quick start' sections to framework guides using the create-prisma scaffolding command.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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


Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

🍈 Lychee Link Check Report

80 links: ✅ 58 OK | 🚫 2 errors | 🔀 0 redirects | 👻 20 excluded

❌ Errors

apps/docs/content/docs/guides/frameworks/astro.mdx

apps/docs/content/docs/guides/frameworks/hono.mdx


Full Statistics Table
Status Count
✅ Successful 58
🔀 Redirected 0
👻 Excluded 20
🚫 Errors 2
⛔ Unsupported 0
⏳ Timeouts 0
❓ Unknown 0

@argos-ci
Copy link
Copy Markdown

argos-ci bot commented Apr 8, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Apr 10, 2026, 3:52 PM

Copy link
Copy Markdown
Contributor

@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 `@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

📥 Commits

Reviewing files that changed from the base of the PR and between 786ece4 and 3a34356.

📒 Files selected for processing (9)
  • apps/docs/content/docs/guides/frameworks/astro.mdx
  • apps/docs/content/docs/guides/frameworks/elysia.mdx
  • apps/docs/content/docs/guides/frameworks/hono.mdx
  • apps/docs/content/docs/guides/frameworks/nestjs.mdx
  • apps/docs/content/docs/guides/frameworks/nextjs.mdx
  • apps/docs/content/docs/guides/frameworks/nuxt.mdx
  • apps/docs/content/docs/guides/frameworks/sveltekit.mdx
  • apps/docs/content/docs/guides/frameworks/tanstack-start.mdx
  • apps/docs/content/docs/guides/index.mdx

Comment on lines +19 to 20
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`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 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-context

Repository: 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 -20

Repository: 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 -30

Repository: 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.json

Repository: 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>
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