Skip to content

docs: add Prisma Next getting started guides#7933

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

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

Conversation

@AmanVarshney01

@AmanVarshney01 AmanVarshney01 commented Jun 4, 2026

Copy link
Copy Markdown
Member

What this PR does

This PR brings the Prisma Next documentation into the repo, makes Prisma Next the default experience when you land in the docs, and updates how we talk about Early Access across the docs and blog.

Prisma Next is the next major version of Prisma ORM and is currently in Early Access. Prisma 7 remains the generally available (GA) release.

TL;DR of what changed

  • 📚 Added the Prisma Next docs: getting-started hub, new-project quickstarts (PostgreSQL + MongoDB), add-to-existing-project guides, a Prisma Postgres quickstart with CLI/import guides, and the Prisma Next ORM overview.
  • 🧭 Default to Prisma Next: bare /docs now redirects to /docs/next, and the website nav Docs / ORM links (plus the footer ORM link) open the Prisma Next docs. The ORM Next intro is labeled Prisma Next in the sidebar, matching the Prisma ORM (Latest) docs.
  • 📣 New Early Access messaging: callouts across the Prisma Next docs and the Prisma Next blog series now invite users to try the cutting-edge next major version and share feedback, instead of saying it is "not production ready." Users who want GA are pointed to Prisma 7.
  • 🔄 Redefined the release lifecycle: on the ORM releases and Console feature-maturity pages, Early Access now means "ready to try, cutting edge, evolves with feedback, API surface won't change drastically," and the Preview wording was softened to match (validate in staging rather than "not for production").

Notes

  • Bare /docs redirects to /docs/next. The Prisma 7 (Latest) getting-started stays reachable at /docs/getting-started — that's where the getting-started version switcher's Latest option and the callouts' Prisma 7 links point — and /docs/orm still serves the Prisma ORM 7 docs.

Validation

  • pnpm --filter docs run lint:links — 0 errors
  • pnpm --filter docs run lint:spellcheck
  • pnpm --filter docs run types:check

@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 Jul 1, 2026 3:18pm
docs Ready Ready Preview, Comment Jul 1, 2026 3:18pm
eclipse Ready Ready Preview, Comment Jul 1, 2026 3:18pm
site Ready Ready Preview, Comment Jul 1, 2026 3:18pm

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
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

98 links: ✅ 24 OK | 🚫 0 errors | 🔀 5 redirects | 👻 69 excluded

✅ All links are working!


Full Statistics Table
Status Count
✅ Successful 24
🔀 Redirected 5
👻 Excluded 69
🚫 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 Jul 1, 2026, 3:24 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.

- Replace "not production ready" callouts with Early Access notes across the
  Prisma Next docs pages, the Prisma Next blog series, and the ORM / Console
  feature-maturity definitions. New messaging: Prisma Next is the next major
  version of Prisma ORM, in Early Access, expect changes, share feedback;
  Prisma 7 is GA, keep using it for production.
- Point the site nav "Docs" link to /docs/next and the nav + footer "ORM"
  links to /docs/orm/next so users land on Prisma Next.
- Rename the ORM Next intro sidebar entry from "What is Prisma Next?" to
  "Prisma Next" for parity with the Prisma ORM (Latest) docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Apply the approved callout wording across all Prisma Next docs pages: invite
users to try the cutting-edge next major version in Early Access and share
feedback, and point anyone who wants the current GA release to Prisma 7.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Early Access now means: ready to try out, cutting edge, and evolving with user
feedback, with an API surface that won't change drastically. Removes the
"prepared for significant breaking changes" framing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…aning

Keeps the Early Access -> Preview -> GA ladder monotonic: Preview is now
described as close to stable, validate in staging, rather than "not
recommended in production."

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Redirect bare /docs to /docs/next so the docs land on Prisma Next by
  default. Keep the Prisma 7 (Latest) getting-started reachable at
  /docs/getting-started: repoint the getting-started version switcher's
  Latest target and the Getting Started tab there (bare "/" now redirects),
  and update the callouts' Prisma 7 links to /getting-started.
- Add spacing under the callout title so the heading no longer sits flush
  against the body (applies to all callouts via CalloutTitle).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
title: Get started with Prisma Next
description: Start a new Prisma Next app or add Prisma Next to an existing project.
title: Introduction to Prisma Next

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.

In the preview, this page appears when you select "Next" in the "Docs version" drop down. We also redirect users to "Next" which I find super jarring when landing on a docs page likely for Prisma 7.

We should use the version dropdown in the getting started page and we already have a pattern that works for this. Prisma Postgres already appears in the navigation list on the left and I think Prisma Next should appear in the same list.

So we should entirely remove the version selection on the getting started page and rather have Prisma Next appear at the top of the left navigation.

We can also add a callout in the Prisma 7/6 docs to drive people there.

The goal is awareness not subverting a users expectations when landing on the Prisma docs. My expectation is to land on the Latest docs.

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.

4 participants