docs: add Prisma Next getting started guides#7933
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis 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. ChangesPrisma Next Documentation Hub Restructuring
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Comment |
🍈 Lychee Link Check Report98 links: ✅ All links are working!Full Statistics Table
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
@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 |
There was a problem hiding this comment.
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.
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
/docsnow 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.Notes
/docsredirects 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/ormstill serves the Prisma ORM 7 docs.Validation
pnpm --filter docs run lint:links— 0 errorspnpm --filter docs run lint:spellcheckpnpm --filter docs run types:check