Skip to content

docs: add Prisma Next getting started guides#7933

Open
AmanVarshney01 wants to merge 3 commits into
prisma-next-eafrom
aman/prisma-next-getting-started
Open

docs: add Prisma Next getting started guides#7933
AmanVarshney01 wants to merge 3 commits into
prisma-next-eafrom
aman/prisma-next-getting-started

Conversation

@AmanVarshney01
Copy link
Copy Markdown
Member

@AmanVarshney01 AmanVarshney01 commented Jun 4, 2026

Summary

  • Adds Prisma Next quickstarts for PostgreSQL and MongoDB using bare create-prisma@next.
  • Reworks the Prisma Next landing page around new-project quickstarts and existing-project setup.
  • Updates existing-project guides to use bare npx prisma-next init and redirects the old create-prisma page back to Getting Started.

Validation

  • pnpm --filter docs run lint:spellcheck
  • pnpm --filter docs run lint:links
  • pnpm --filter docs run types:check
  • Browser checked /docs/next, quickstart pages, existing-project pages, and redirects.

Summary by CodeRabbit

  • Documentation
    • Restructured Prisma Next onboarding and getting-started content; removed one legacy guide.
    • Added Quickstart guides for PostgreSQL and MongoDB and new Prisma Postgres guides (imports, CLI).
    • Rewrote several Next pages and “Next steps” guidance to emphasize contract re-emission and link migration docs.
  • Navigation
    • Updated doc navigation, redirects, and versioned route mappings.
  • Style / UI
    • Added Prisma Next banner visuals and adjusted sidebar badge visibility.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 4, 2026

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

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Jun 4, 2026 2:33pm
docs Ready Ready Preview, Comment Jun 4, 2026 2:33pm
eclipse Ready Ready Preview, Comment Jun 4, 2026 2:33pm
site Ready Ready Preview, Comment Jun 4, 2026 2:33pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

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: 17a20e8e-70f4-4309-98f2-8c0fd7af88bb

📥 Commits

Reviewing files that changed from the base of the PR and between f61564d and eec325f.

📒 Files selected for processing (19)
  • apps/docs/content/docs/(index)/next/add-to-existing-project/mongodb.mdx
  • apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx
  • apps/docs/content/docs/(index)/next/getting-started.mdx
  • apps/docs/content/docs/(index)/next/index.mdx
  • apps/docs/content/docs/(index)/next/meta.json
  • apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-mysql.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/meta.json
  • apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/meta.json
  • apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/prisma-next.mdx
  • apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx
  • apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx
  • apps/docs/next.config.mjs
  • apps/docs/src/app/global.css
  • apps/docs/src/app/layout.tsx
  • apps/docs/src/components/sidebar-badge-provider.tsx
  • apps/docs/src/lib/version.ts
  • apps/docs/src/lib/versioned-sidebar-tree.ts
✅ Files skipped from review due to trivial changes (8)
  • apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/meta.json
  • apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx
  • apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx
  • apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx
  • apps/docs/content/docs/(index)/next/meta.json
  • apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/prisma-next.mdx
  • apps/docs/content/docs/(index)/next/getting-started.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/src/lib/version.ts

Walkthrough

The PR replaces the single create-prisma guide with dedicated PostgreSQL and MongoDB quickstarts, adds Prisma Postgres documentation, restructures the /next hub and getting-started pages into card-based navigation, harmonizes add-to-existing-project guides and CLI links, updates redirects/version mappings, and adjusts site UI and sidebar badging for Prisma Next.

Changes

Prisma Next Documentation Reorganization

Layer / File(s) Summary
Create new quickstart pages and navigation metadata
apps/docs/content/docs/(index)/next/quickstart/postgresql.mdx, apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx, apps/docs/content/docs/(index)/next/quickstart/meta.json
PostgreSQL and MongoDB quickstart pages are added with step-by-step instructions, prerequisites, and next-step navigation. The quickstart metadata configuration registers both pages under /next/quickstart.
Restructure main /next hub and getting-started
apps/docs/content/docs/(index)/next/index.mdx, apps/docs/content/docs/(index)/next/getting-started.mdx, apps/docs/content/docs/(index)/next/meta.json
The main entry point and a new getting-started page are rewritten with a "Start here" flow and card-based navigation pointing to the new quickstarts, Prisma Postgres paths, and existing-project guides. Navigation metadata is updated to reference quickstart and Prisma Postgres sections.
Harmonize existing-project guides for both databases
apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx, apps/docs/content/docs/(index)/next/add-to-existing-project/mongodb.mdx
Both guides are updated to use npx prisma-next init (removing --write-env), clarify the existing-project workflow, update .env examples, and rewrite the Next steps to emphasize contract re-emission with links to db update and migration plan docs.
Add Prisma Postgres docs and CLI flow
apps/docs/content/docs/(index)/next/prisma-postgres/*
New Prisma Postgres documentation (quickstart, CLI guide, and import-from-existing-database pages) is added along with meta configuration to register these pages.
Update routing rules and cross-document references
apps/docs/next.config.mjs, apps/docs/src/lib/version.ts, apps/docs/content/docs/cli/next/init.mdx, apps/docs/content/docs/cli/next/index.mdx, apps/docs/content/docs/orm/index.mdx, apps/docs/content/docs/orm/next/index.mdx
Redirects and version-path mappings are updated so quickstart and getting-started routes point to the new pages; CLI and ORM docs are updated to reference the quickstart/getting-started flow.
Site UI: banner, CSS, layout updates
apps/docs/src/app/global.css, apps/docs/src/app/layout.tsx
Adds banner CSS/animations and updates banner markup to use new classes and an ArrowRightIcon in the CTA.
Sidebar badge visibility and versioned sidebar tree
apps/docs/src/components/sidebar-badge-provider.tsx, apps/docs/src/lib/versioned-sidebar-tree.ts
Adds logic to hide the "early-access" badge on Prisma Next sections and expands detection logic for the "next" Getting Started sidebar nodes.

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding comprehensive getting-started guides for Prisma Next, covering quickstarts, existing-project setups, and Prisma Postgres integration.
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.


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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

🍈 Lychee Link Check Report

66 links: ✅ 3 OK | 🚫 0 errors | 🔀 1 redirects | 👻 62 excluded

✅ All links are working!


Full Statistics Table
Status Count
✅ Successful 3
🔀 Redirected 1
👻 Excluded 62
🚫 Errors 0
⛔ Unsupported 0
⏳ Timeouts 0
❓ Unknown 0

@argos-ci
Copy link
Copy Markdown

argos-ci Bot commented Jun 4, 2026

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

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 1 changed Jun 4, 2026, 2:40 PM

Comment thread apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx Outdated
Comment thread apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx Outdated
Comment thread apps/docs/content/docs/(index)/next/quickstart/mongodb.mdx Outdated
@ankur-arch
Copy link
Copy Markdown
Contributor

@AmanVarshney01 The versioning dropdown currently lets users switch to the Prisma Next docs, which is great. Could we also make Prisma Next more prominent in the latest docs?

Since Prisma Next will become the next major version, it would be useful to add a clear callout encouraging users to try it out and share feedback.

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.

2 participants