Skip to content

Conversation

ankur-arch
Copy link
Contributor

@ankur-arch ankur-arch commented Sep 2, 2025

Summary by CodeRabbit

  • Documentation
    • Updated multi-file Prisma schema guidance with a simplified example and a note recommending using the Prisma Config to specify schema location; added tips on migrations directory placement.
    • Clarified generator defaults: prisma-client-js is the default for Prisma ORM 6.x and earlier; added preview details for the ESM-first prisma-client generator and migration recommendation for Prisma ORM 7.0.
    • Advised setting a custom output path and running prisma generate via build/postinstall.
    • Updated hyphen usage reference link.
  • Style
    • Minor formatting improvements.

@ankur-arch ankur-arch requested a review from nurul3101 September 2, 2025 11:12
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 2, 2025

Walkthrough

Documentation updates: simplified the exported PrismaConfig example in the schema location guide (removed earlyAccess and generic), added notes recommending using the Prisma Config for schema path and migrations placement, clarified generator documentation distinguishing prisma-client-js (default for ≤6.x) from the preview prisma-client, and replaced a hyphen guideline link.

Changes

Cohort / File(s) Summary
PrismaConfig schema location docs
content/200-orm/100-prisma-schema/10-overview/04-location.mdx
Updated example to export default { schema: path.join('prisma') } satisfies PrismaConfig (removed earlyAccess and generic). Added note recommending Prisma Config for schema location and guidance on multi-file schemas and migrations directory placement.
Prisma client generator reference
content/200-orm/500-reference/100-prisma-schema-reference.mdx
Added clarification that prisma-client-js is the default generator for Prisma ORM 6.x and earlier; introduced a prisma-client (Preview) section describing the ESM-first generator, migration note indicating it will be default in 7.0, and an admonition to define custom output and run prisma generate via build/postinstall. Minor formatting tweaks.
Style guide — hyphen reference
content/600-about/20-style-guide/03-spelling-punctuation-formatting.mdx
Replaced Hyphens reference link from GrammarBook to Grammarly; no other content changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • nurul3101
  • nikolasburk

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6b1c142 and e2ee0aa.

📒 Files selected for processing (1)
  • content/600-about/20-style-guide/03-spelling-punctuation-formatting.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • content/600-about/20-style-guide/03-spelling-punctuation-formatting.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector
  • GitHub Check: Lost Pixel
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ankur/patch-prisma-config

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

  • This PR does not change any pages in a way that would require a redirect.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Sep 2, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: e2ee0aa
Status: ✅  Deploy successful!
Preview URL: https://406925ed.docs-51g.pages.dev
Branch Preview URL: https://ankur-patch-prisma-config.docs-51g.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

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

⚠️ Outside diff range comments (1)
content/200-orm/500-reference/100-prisma-schema-reference.mdx (1)

175-176: Remove moduleFormat from the prisma-client-js field table

Listing moduleFormat under prisma-client-js but stating it is only available with prisma-client is confusing. Suggest removing it from this table (it’s correctly documented under the prisma-client section).

-| `moduleFormat`    | No       | Enum (`cjs` or `esm`)                           | Defines the module format of the generated Prisma Client. This field is available only with `prisma-client` generator.                                                                                                                         |

References show moduleFormat applies to the preview prisma-client generator, not prisma-client-js. (prisma.io)

🧹 Nitpick comments (2)
content/200-orm/100-prisma-schema/10-overview/04-location.mdx (1)

72-72: Fix small typos in this page

Two minor text nits:

  • Line 72: “pass the the --schema option” → “pass the --schema option”
  • Line 102: “here's how how need to place” → “here’s how you need to place”
- - pass the the `--schema` option to your Prisma CLI command (e.g. `prisma migrate dev --schema ./prisma`) 
+ - pass the `--schema` option to your Prisma CLI command (e.g. `prisma migrate dev --schema ./prisma`) 

- For example, assuming `schema.prisma` defines the `datasource`, here's how how need to place the migrations folder:
+ For example, assuming `schema.prisma` defines the `datasource`, here’s how you need to place the migrations folder:

Also applies to: 102-102

content/200-orm/500-reference/100-prisma-schema-reference.mdx (1)

177-181: Admonition style consistency

You’re using “:::note[important]” here while other parts of the page use either plain “:::note” or the <Admonition> MDX component. Consider standardizing to the dominant style for consistency.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8336c9f and 6b1c142.

📒 Files selected for processing (2)
  • content/200-orm/100-prisma-schema/10-overview/04-location.mdx (1 hunks)
  • content/200-orm/500-reference/100-prisma-schema-reference.mdx (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ankur-arch
PR: prisma/docs#7066
File: content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/245-troubleshooting-binary-size-issues.mdx:8-22
Timestamp: 2025-08-11T09:40:55.237Z
Learning: When the queryCompiler preview feature is enabled in Prisma ORM (v6.7.0+), it does not require Rust engines for CLI tools like `prisma migrate` or `prisma db pull`. The previous understanding that CLI tools would still need Rust binaries even with queryCompiler enabled is incorrect.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector
  • GitHub Check: Lost Pixel
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (4)
content/200-orm/100-prisma-schema/10-overview/04-location.mdx (2)

87-90: PrismaConfig sample: good update

Dropping earlyAccess and PrismaConfig<Env> in favor of satisfies PrismaConfig matches current Prisma Config guidance.
See reference. (prisma.io)


92-97: Helpful callout

The new note recommending Prisma Config for schema path is clear and aligns with Config docs.
(prisma.io)

content/200-orm/500-reference/100-prisma-schema-reference.mdx (2)

164-165: Clarification about default generator (6.x and earlier): looks good

Calling out that prisma-client-js is the default up to 6.x helps readers during the v7 transition.
(prisma.io)


185-192: Preview generator section: content aligns with current status—keep runtime list fresh

The description of the ESM-first prisma-client and the note about becoming default in v7 are accurate; as of September 2, 2025 the latest release is 6.15.0 (not yet v7). Also, the runtime values you list (nodejs, deno, bun, workerd, vercel-edge, react-native) match the latest 6.15.0 change log updates.

  • If this page ships after v7 GA, update phrasing from “will be the default” to “is the default”.
  • Confirm the runtime list stays in sync with release notes.

Sources: latest releases and generator docs. (github.com, prisma.io)

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 2, 2025
nikolasburk
nikolasburk previously approved these changes Sep 2, 2025
Copy link
Member

@nikolasburk nikolasburk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking good!

@ankur-arch ankur-arch merged commit 22bc1d1 into main Sep 2, 2025
8 of 10 checks passed
@ankur-arch ankur-arch deleted the ankur/patch-prisma-config branch September 2, 2025 13:00
jlecordier pushed a commit to jlecordier/docs-1 that referenced this pull request Sep 3, 2025
* fix: add callout to Prisma Config DC-4961

* fix: add callouts to the new prisma-client generator

* fix: replace grammarbook link
This was referenced Sep 11, 2025
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.

3 participants