Skip to content

docs: add Prisma Next getting started guides#7933

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

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

Conversation

@AmanVarshney01

@AmanVarshney01 AmanVarshney01 commented Jun 4, 2026

Copy link
Copy Markdown
Member

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

    • Reorganized Prisma Next getting-started flow with a new central "Choose a setup path" page and clearer new-vs-existing app guidance
    • Added Prisma Postgres quickstart and CLI/import guides (Postgres & MySQL)
    • Removed or consolidated many outdated Next-specific concept/guide pages and updated navigation/redirects for better discoverability
  • Style

    • Updated Prisma Next docs banner visuals and CTA styling
  • Chore

    • Suppressed early-access sidebar badges on select Next sections

@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Jun 9, 2026 10:02am
docs Ready Ready Preview, Comment Jun 9, 2026 10:02am
eclipse Ready Ready Preview, Comment Jun 9, 2026 10:02am
site Ready Ready Preview, Comment Jun 9, 2026 10:02am

Request Review

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

This PR reorganizes Prisma Next docs: adds Prisma Postgres quickstarts and import guides, creates a /next/getting-started hub and a "What is Prisma Next?" page, harmonizes add-to-existing instructions, updates redirects/version mappings, and adjusts banner styling and sidebar badge behavior.

Changes

Prisma Next Documentation Hub Restructuring

Layer / File(s) Summary
Prisma Postgres quickstart and import guides
apps/docs/content/docs/(index)/next/prisma-postgres/*, apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/*
New Prisma Postgres quickstart, CLI "from-the-cli" guide, and import-from-existing-database pages (PostgreSQL & MySQL) with meta registration.
Restructure /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
Rewrite /next landing to card-based navigation, add /next/getting-started as the central decision page, and update meta.json to expose getting-started and prisma-postgres sections.
Add What is Prisma Next?
apps/docs/content/docs/(index)/next/what-is-prisma-next.mdx
New informational page introducing Prisma Next with frontmatter and an announcement link.
Harmonize add-to-existing-project guides
apps/docs/content/docs/(index)/next/add-to-existing-project/mongodb.mdx, apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx
Change init command to npx prisma-next init (remove --write-env), clarify existing-project flow and injected artifacts, update DATABASE_URL examples, and simplify Next steps to contract re-emit guidance linking to migration docs.
Update redirects, CLI links, and version mappings
apps/docs/next.config.mjs, apps/docs/content/docs/cli/next/index.mdx, apps/docs/content/docs/cli/next/init.mdx, apps/docs/src/lib/version.ts
Retarget old create-prisma/quickstart redirects to /next/getting-started, update CLI docs to point to the getting-started guide, and expand latest↔next mappings for prisma-postgres and getting-started pages.
ORM section updates and removals
apps/docs/content/docs/orm/index.mdx, apps/docs/content/docs/orm/next/index.mdx, apps/docs/content/docs/orm/next/meta.json, apps/docs/content/docs/orm/next/extensions/*, apps/docs/content/docs/orm/next/guides/*, apps/docs/content/docs/orm/next/concepts/*
Add Prisma Next early-access admonition to ORM index, simplify orm/next index frontmatter, narrow orm/next meta.json to index only, and remove several detailed orm/next concept, guide, and extension pages.
Banner styling and sidebar badge visibility
apps/docs/src/app/global.css, apps/docs/src/app/layout.tsx, apps/docs/src/components/sidebar-badge-provider.tsx, apps/docs/src/lib/versioned-sidebar-tree.ts
Add banner CSS animations and layout, update layout CTA with ArrowRightIcon and prisma-next-banner classes, hide early-access badges on Prisma Next sections, and broaden sidebar Getting Started detection for next docs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • prisma/web#7909: Related removal of PostGIS/geometry documentation pages.
🚥 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 PR title clearly and concisely describes the primary change: adding Prisma Next getting started guides, which aligns perfectly with the core objectives of reworking the landing page and adding quickstart documentation.
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

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

61 links: ✅ 4 OK | 🚫 0 errors | 🔀 1 redirects | 👻 56 excluded

✅ All links are working!


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

@argos-ci

argos-ci Bot commented Jun 4, 2026

Copy link
Copy Markdown

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

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 1 changed Jun 9, 2026, 10:08 AM

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.

@coderabbitai coderabbitai Bot left a comment

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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
apps/docs/src/lib/version.ts (1)

43-57: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add reverse mapping for /next/prisma-postgres to preserve version-switch context.

When switching from Next → Latest on Line 43-57, /next/prisma-postgres is currently unmapped, so fallback sends users to / instead of /prisma-postgres. This loses section context in the version switch flow.

Suggested patch
 const LATEST_GETTING_STARTED_PATHS_BY_NEXT_PATH = new Map<string, string>([
   [NEXT_GETTING_STARTED_ROOT, "/"],
   ["/next/getting-started", "/getting-started"],
   ["/next/what-is-prisma-next", "/prisma-orm"],
+  ["/next/prisma-postgres", "/prisma-postgres"],
   ["/next/prisma-postgres/quickstart/prisma-next", "/prisma-postgres/quickstart/prisma-orm"],
   [
     "/next/prisma-postgres/import-from-existing-database-postgresql",
     "/prisma-postgres/import-from-existing-database-postgresql",
   ],
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/docs/src/lib/version.ts` around lines 43 - 57, The map
LATEST_GETTING_STARTED_PATHS_BY_NEXT_PATH is missing a reverse entry for the
"/next/prisma-postgres" section causing the version switch to fall back to "/"
and lose context; add an entry mapping "/next/prisma-postgres" to
"/prisma-postgres" alongside the other entries (update the
LATEST_GETTING_STARTED_PATHS_BY_NEXT_PATH constant near
NEXT_GETTING_STARTED_ROOT) so switching from Next → Latest preserves the
prisma-postgres section context.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@apps/docs/src/lib/version.ts`:
- Around line 43-57: The map LATEST_GETTING_STARTED_PATHS_BY_NEXT_PATH is
missing a reverse entry for the "/next/prisma-postgres" section causing the
version switch to fall back to "/" and lose context; add an entry mapping
"/next/prisma-postgres" to "/prisma-postgres" alongside the other entries
(update the LATEST_GETTING_STARTED_PATHS_BY_NEXT_PATH constant near
NEXT_GETTING_STARTED_ROOT) so switching from Next → Latest preserves the
prisma-postgres section context.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0d5cc393-df31-46a4-8adc-7b639e51bfed

📥 Commits

Reviewing files that changed from the base of the PR and between a01db52 and ea29120.

📒 Files selected for processing (31)
  • apps/docs/content/docs/(index)/next/add-to-existing-project/meta.json
  • 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/quickstart/prisma-next.mdx
  • apps/docs/content/docs/(index)/next/what-is-prisma-next.mdx
  • apps/docs/content/docs/cli/next/index.mdx
  • apps/docs/content/docs/cli/next/init.mdx
  • apps/docs/content/docs/orm/next/concepts/contract-first-design.mdx
  • apps/docs/content/docs/orm/next/concepts/extension-packs.mdx
  • apps/docs/content/docs/orm/next/concepts/meta.json
  • apps/docs/content/docs/orm/next/concepts/query-apis.mdx
  • apps/docs/content/docs/orm/next/concepts/schema-definition-and-contract-emission.mdx
  • apps/docs/content/docs/orm/next/extensions/cipherstash.mdx
  • apps/docs/content/docs/orm/next/extensions/meta.json
  • apps/docs/content/docs/orm/next/extensions/pgvector.mdx
  • apps/docs/content/docs/orm/next/extensions/postgis.mdx
  • apps/docs/content/docs/orm/next/guides/building-queries-with-sql-dsl.mdx
  • apps/docs/content/docs/orm/next/guides/deploying-to-serverless-runtimes.mdx
  • apps/docs/content/docs/orm/next/guides/error-handling-patterns.mdx
  • apps/docs/content/docs/orm/next/guides/managing-database-migrations.mdx
  • apps/docs/content/docs/orm/next/guides/meta.json
  • apps/docs/content/docs/orm/next/guides/using-the-orm-client.mdx
  • apps/docs/content/docs/orm/next/index.mdx
  • apps/docs/content/docs/orm/next/meta.json
  • apps/docs/src/lib/version.ts
💤 Files with no reviewable changes (18)
  • apps/docs/content/docs/orm/next/guides/error-handling-patterns.mdx
  • apps/docs/content/docs/orm/next/guides/managing-database-migrations.mdx
  • apps/docs/content/docs/orm/next/guides/using-the-orm-client.mdx
  • apps/docs/content/docs/orm/next/concepts/meta.json
  • apps/docs/content/docs/orm/next/guides/deploying-to-serverless-runtimes.mdx
  • apps/docs/content/docs/orm/next/extensions/meta.json
  • apps/docs/content/docs/orm/next/concepts/query-apis.mdx
  • apps/docs/content/docs/orm/next/guides/meta.json
  • apps/docs/content/docs/(index)/next/add-to-existing-project/meta.json
  • apps/docs/content/docs/orm/next/concepts/contract-first-design.mdx
  • apps/docs/content/docs/orm/next/concepts/schema-definition-and-contract-emission.mdx
  • apps/docs/content/docs/orm/next/concepts/extension-packs.mdx
  • apps/docs/content/docs/orm/next/extensions/cipherstash.mdx
  • apps/docs/content/docs/orm/next/extensions/pgvector.mdx
  • apps/docs/content/docs/orm/next/extensions/postgis.mdx
  • apps/docs/content/docs/orm/next/guides/building-queries-with-sql-dsl.mdx
  • apps/docs/content/docs/(index)/next/add-to-existing-project/postgresql.mdx
  • apps/docs/content/docs/(index)/next/add-to-existing-project/mongodb.mdx
✅ Files skipped from review due to trivial changes (8)
  • apps/docs/content/docs/cli/next/init.mdx
  • apps/docs/content/docs/orm/next/meta.json
  • apps/docs/content/docs/(index)/next/what-is-prisma-next.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/from-the-cli.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/quickstart/prisma-next.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-mysql.mdx
  • apps/docs/content/docs/(index)/next/getting-started.mdx
  • apps/docs/content/docs/(index)/next/prisma-postgres/import-from-existing-database-postgresql.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/docs/content/docs/orm/next/index.mdx
  • apps/docs/content/docs/(index)/next/meta.json

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