Skip to content

Prisma Next Post Merge Polish#8043

Open
nurul3101 wants to merge 5 commits into
mainfrom
docs/next-post-merge-polish
Open

Prisma Next Post Merge Polish#8043
nurul3101 wants to merge 5 commits into
mainfrom
docs/next-post-merge-polish

Conversation

@nurul3101

@nurul3101 nurul3101 commented Jul 9, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Marked multiple Prisma Next documentation pages as early access.
    • Updated “Prompt your coding agent” guidance to use create-prisma@next and improved links to available Prisma Next skills.
    • Refreshed contract/schema and query/migration guidance, including clearer naming and updated MongoDB .where(...) behavior notes and runtime error example details.
  • Style
    • Improved code snippet formatting with MDX-native tabbed layouts and refined presentation/margins for inactive tabs.

nurul3101 and others added 4 commits July 8, 2026 22:36
… fundamentals

reading-data: MongoDB where() also accepts MongoFieldFilter expressions
(comparisons, .and()/.not(), MongoOrExpr.of), not the object form only;
link to the reference filter section.

writing-data: stop presenting .push() as plainly usable; the reference
marks array operations as unverified. Point to a verified op instead
and link to the field-operations reference section.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The general Tabs' TabsContent kept fumadocs' [&>figure:only-child]:-m-4
bleed, but unlike fumadocs (and the padded codetabs variant) its container
has no padding to compensate, so a lone code block was pulled 1rem up over
the PostgreSQL/MongoDB tab triggers on every tab= code fence. Replace the
bleed with a snug mt-2/mb-0 so the code block sits below the tab row.

Also remove two console.log calls that fired on every npm-tab interaction.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Convert pure-code <Tabs> blocks in contract-authoring to tab= fences
  (house convention; the one prose-bearing pair stays a component).
- Fix db.sql.public.postTag -> post_tag in advanced-queries (mapped table
  names are snake_case) and align the accessor wording with the reference.
- Correct the contract-artifact roots explanation to cover both the SQL
  table accessor (root key) and the ORM accessor (model name).
- Rescope the TypeScript-builder relation-target claim: PG takes model
  objects, MongoDB takes type-checked model names.
- Add badge: early-access to the fundamentals and contract-authoring
  pages (every other Prisma Next page carries it).
- Use "contract" (not "schema") for the authored artifact in
  data-modeling/index and how-migrations-work.
- Name the RUNTIME.ITERATOR_CONSUMED code in reading-data's streaming note.
- Normalize create-prisma -> create-prisma@next across the section.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@nurul3101 nurul3101 requested a review from ankur-arch July 9, 2026 08:16
@nurul3101 nurul3101 self-assigned this Jul 9, 2026
@vercel

vercel Bot commented Jul 9, 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 9, 2026 12:16pm
docs Ready Ready Preview, Comment Jul 9, 2026 12:16pm
eclipse Ready Ready Preview, Comment Jul 9, 2026 12:16pm
site Ready Ready Preview, Comment Jul 9, 2026 12:16pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

This PR updates Prisma Next docs across contract-authoring, data-modeling, fundamentals, middleware, migrations, guides, extensions, and reference pages, adding early-access badges, changing scaffold references to create-prisma@next, and revising several examples and explanations. It also removes debug logging from Eclipse code block tabs and adjusts tab content spacing.

Changes

Documentation updates for Prisma Next early access

Layer / File(s) Summary
Contract authoring docs
apps/docs/content/docs/orm/next/contract-authoring/capabilities.mdx, psl-syntax.mdx, the-contract-artifact.mdx, the-data-contract.mdx, typescript-schema-builder.mdx
Adds early-access badges, converts tabbed examples to MDX-native fences, updates contract/data-contract wording, and changes scaffold references to create-prisma@next.
Data modeling, guides, and extensions
apps/docs/content/docs/orm/next/data-modeling/index.mdx, mongodb.mdx, relational-databases.mdx, apps/docs/content/docs/guides/next/frameworks/*, apps/docs/content/docs/guides/next/runtimes/*, apps/docs/content/docs/orm/next/extensions/using-extensions.mdx
Rewords schema-to-contract terminology, links Prisma Next skills in guide prompts, and adjusts the extension guidance sentence.
Fundamentals docs
apps/docs/content/docs/orm/next/fundamentals/advanced-queries.mdx, reading-data.mdx, relations-and-joins.mdx, transactions.mdx, writing-data.mdx
Adds early-access badges, updates SQL table naming and MongoDB read/write guidance, adds an iterator-consumed error code, and updates scaffold references.
Middleware and migrations docs
apps/docs/content/docs/orm/next/middleware/*, apps/docs/content/docs/orm/next/migrations/*
Updates scaffold wording, ref anchors, contract emit descriptions, operation phases, and the migration graph walkthrough.
Reference docs
apps/docs/content/docs/orm/next/reference/orm-client.mdx, raw-queries.mdx, sql-query-builder.mdx, transactions-and-runtime.mdx
Refines reference prose and heading formatting in client, raw query, SQL builder, and runtime pages.

Eclipse component cleanup

Layer / File(s) Summary
Debug log removal and figure styling
packages/eclipse/src/components/codeblock.tsx, packages/eclipse/src/components/tabs.tsx
Removes console.log calls from CodeBlockTabs and changes the figure-only-child class from negative margin and no border to top and bottom margins.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

  • prisma/web#8008: Directly updates the same Prisma Next middleware docs pages with create-prisma@next prompt wording.
  • prisma/web#8011: Touches the same Prisma Next fundamentals MDX pages and overlapping prompt guidance.
  • prisma/web#8024: Modifies the same contract-authoring MDX pages with closely related badge and wording updates.
🚥 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 summarizes the broad writing-polish pass across Prisma Next docs after merge.
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.

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

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

266 links: ✅ 19 OK | 🚫 0 errors | 🔀 1 redirects | 👻 246 excluded

✅ All links are working!


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

@argos-ci

argos-ci Bot commented Jul 9, 2026

Copy link
Copy Markdown

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

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Jul 9, 2026, 12:23 PM

- Rewrite the-migration-graph page around the real problem (branches merge,
  every database must catch up): user-problem opening, "When this matters",
  a terms glossary, an Alice/Bob phone+avatarUrl worked example, an explicit
  "What happens when you run migrate" list, task-oriented command tables, a
  "Common tasks" section before the agent prompts, a tip box, and
  impact-framed early-access limitations. Drop clever phrasing.
- Replace question-style openers ("New to X? Start with...") with direct
  phrasing across data-modeling and contract-authoring pages.
- Normalize every "Prompt your coding agent" section to link
  [Prisma Next skills](/ai/tools/skills#available-skills-for-prisma-next).
- Break the ops.json operation paragraph in how-migrations-work into a
  numbered precheck/execute/postcheck list plus a bulleted operation-class list.
- Remove em dashes from reference-page prose and headings.

All commands, flags, refs, and graph output verified against prisma-next
0.14.x. cspell and lint:links pass.

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

Copy link
Copy Markdown
Contributor

Pushed a writing-polish pass over the merged /orm/next and /guides/next content (commit ce0a34fde).

The migration graph page got the heaviest rework. It now opens with the real problem (you add phone, a teammate adds avatarUrl, both merge, and every database has to catch up) instead of leading with the graph abstraction. New structure: When this mattersThe short version → a "you probably just want three commands" tip → Terms used on this page glossary → How it works → an Alice/Bob worked example with the real migration graph output → What happens when you run migrate (numbered) → task-oriented command tables → refs → benefits (H3s) → Database-specific details → impact-framed Early-access limitationsCommon tasks (before the agent prompts). Clever phrasing ("drops the line") is gone.

Applied across the tree:

  • Question-style openers ("New to models and keys? Start with…") → direct phrasing ("If you are new to models and keys, start with…").
  • Every Prompt your coding agent section now links [Prisma Next skills](/ai/tools/skills#available-skills-for-prisma-next) consistently (25 links, all anchored).
  • The ops.json operation paragraph in How migrations work is now a numbered precheck/execute/postcheck list plus a bulleted operation-class list.
  • Removed em dashes from reference-page prose and headings (kept them only in literal CLI-output blocks, code comments, and table empty-cell markers).

Validation: all graph output, ref/migrate commands, flags, reserved tokens (@contract/@db), and the migrations/app/refs/ location verified against the live prisma-next CLI. cspell and lint:links pass over the full tree.

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

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@apps/docs/content/docs/orm/next/migrations/the-migration-graph.mdx`:
- Around line 201-205: Update the “See also” cross-reference in the migration
graph doc so it matches the terminology used by the linked “How migrations work”
page. In the list item referencing How migrations work, replace the
“plan-review-apply loop” wording with the documented “plan, edit, apply, roll
back” loop, using the existing link text and the related headings in the
migrations docs as guidance.
🪄 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: d3b9cd44-ddd8-433e-bb08-00718af2c370

📥 Commits

Reviewing files that changed from the base of the PR and between 71f3326 and ce0a34f.

📒 Files selected for processing (28)
  • apps/docs/content/docs/guides/next/frameworks/elysia.mdx
  • apps/docs/content/docs/guides/next/frameworks/hono.mdx
  • apps/docs/content/docs/guides/next/runtimes/bun.mdx
  • apps/docs/content/docs/guides/next/runtimes/deno.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/capabilities.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/psl-syntax.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/the-contract-artifact.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/the-data-contract.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/typescript-schema-builder.mdx
  • apps/docs/content/docs/orm/next/data-modeling/index.mdx
  • apps/docs/content/docs/orm/next/data-modeling/mongodb.mdx
  • apps/docs/content/docs/orm/next/data-modeling/relational-databases.mdx
  • apps/docs/content/docs/orm/next/extensions/using-extensions.mdx
  • apps/docs/content/docs/orm/next/fundamentals/advanced-queries.mdx
  • apps/docs/content/docs/orm/next/fundamentals/reading-data.mdx
  • apps/docs/content/docs/orm/next/fundamentals/relations-and-joins.mdx
  • apps/docs/content/docs/orm/next/fundamentals/transactions.mdx
  • apps/docs/content/docs/orm/next/fundamentals/writing-data.mdx
  • apps/docs/content/docs/orm/next/middleware/authoring-custom-middleware.mdx
  • apps/docs/content/docs/orm/next/middleware/how-middleware-works.mdx
  • apps/docs/content/docs/orm/next/migrations/applying-a-migration.mdx
  • apps/docs/content/docs/orm/next/migrations/generating-a-migration.mdx
  • apps/docs/content/docs/orm/next/migrations/how-migrations-work.mdx
  • apps/docs/content/docs/orm/next/migrations/the-migration-graph.mdx
  • apps/docs/content/docs/orm/next/reference/orm-client.mdx
  • apps/docs/content/docs/orm/next/reference/raw-queries.mdx
  • apps/docs/content/docs/orm/next/reference/sql-query-builder.mdx
  • apps/docs/content/docs/orm/next/reference/transactions-and-runtime.mdx
✅ Files skipped from review due to trivial changes (26)
  • apps/docs/content/docs/orm/next/fundamentals/relations-and-joins.mdx
  • apps/docs/content/docs/orm/next/extensions/using-extensions.mdx
  • apps/docs/content/docs/guides/next/runtimes/deno.mdx
  • apps/docs/content/docs/guides/next/frameworks/hono.mdx
  • apps/docs/content/docs/orm/next/migrations/applying-a-migration.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/the-data-contract.mdx
  • apps/docs/content/docs/orm/next/data-modeling/relational-databases.mdx
  • apps/docs/content/docs/orm/next/middleware/authoring-custom-middleware.mdx
  • apps/docs/content/docs/guides/next/runtimes/bun.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/capabilities.mdx
  • apps/docs/content/docs/orm/next/data-modeling/mongodb.mdx
  • apps/docs/content/docs/orm/next/reference/raw-queries.mdx
  • apps/docs/content/docs/guides/next/frameworks/elysia.mdx
  • apps/docs/content/docs/orm/next/migrations/generating-a-migration.mdx
  • apps/docs/content/docs/orm/next/fundamentals/transactions.mdx
  • apps/docs/content/docs/orm/next/data-modeling/index.mdx
  • apps/docs/content/docs/orm/next/reference/transactions-and-runtime.mdx
  • apps/docs/content/docs/orm/next/middleware/how-middleware-works.mdx
  • apps/docs/content/docs/orm/next/migrations/how-migrations-work.mdx
  • apps/docs/content/docs/orm/next/reference/sql-query-builder.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/the-contract-artifact.mdx
  • apps/docs/content/docs/orm/next/fundamentals/writing-data.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/psl-syntax.mdx
  • apps/docs/content/docs/orm/next/reference/orm-client.mdx
  • apps/docs/content/docs/orm/next/contract-authoring/typescript-schema-builder.mdx
  • apps/docs/content/docs/orm/next/fundamentals/advanced-queries.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/docs/orm/next/fundamentals/reading-data.mdx

Comment on lines 201 to 205
## See also

- [How migrations work](/orm/next/migrations/how-migrations-work): the planreviewapply loop
- [How migrations work](/orm/next/migrations/how-migrations-work): the plan-review-apply loop
- [Applying a migration](/orm/next/migrations/applying-a-migration): how the runner walks the graph
- [Rollbacks and recovery](/orm/next/migrations/rollbacks-and-recovery): backwards edges in practice

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.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Terminology drift: "plan-review-apply loop" vs. documented "plan, edit, apply, roll back" loop.

This page describes the linked How migrations work page's loop as "the plan-review-apply loop," but that page itself documents the core loop as "plan, edit, apply, roll back" (no "review" step, and it explicitly includes rollback). This cross-reference mismatch could confuse readers looking for a "review" step that doesn't exist as a named stage.

✏️ Proposed fix
-- [How migrations work](/orm/next/migrations/how-migrations-work): the plan-review-apply loop
+- [How migrations work](/orm/next/migrations/how-migrations-work): the plan-edit-apply-rollback loop

Based on the relevant code snippet from apps/docs/content/docs/orm/next/migrations/how-migrations-work.mdx:227-245, which states "The core loop on this page (plan, edit, apply, roll back) works today and is exercised in the Prisma Next test suite."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## See also
- [How migrations work](/orm/next/migrations/how-migrations-work): the plan–review–apply loop
- [How migrations work](/orm/next/migrations/how-migrations-work): the plan-review-apply loop
- [Applying a migration](/orm/next/migrations/applying-a-migration): how the runner walks the graph
- [Rollbacks and recovery](/orm/next/migrations/rollbacks-and-recovery): backwards edges in practice
## See also
- [How migrations work](/orm/next/migrations/how-migrations-work): the plan-edit-apply-rollback loop
- [Applying a migration](/orm/next/migrations/applying-a-migration): how the runner walks the graph
- [Rollbacks and recovery](/orm/next/migrations/rollbacks-and-recovery): backwards edges in practice
🤖 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/content/docs/orm/next/migrations/the-migration-graph.mdx` around
lines 201 - 205, Update the “See also” cross-reference in the migration graph
doc so it matches the terminology used by the linked “How migrations work” page.
In the list item referencing How migrations work, replace the “plan-review-apply
loop” wording with the documented “plan, edit, apply, roll back” loop, using the
existing link text and the related headings in the migrations docs as guidance.

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