Skip to content

Conversation

@ankur-arch
Copy link
Contributor

@ankur-arch ankur-arch commented Nov 16, 2025

Summary by CodeRabbit

  • Documentation
    • Added comprehensive debugging examples for configuring the DEBUG environment variable in bash and Windows.
    • Clarified Prisma ORM v7 compatibility across CLI reference and environment variables documentation with deprecation notices.
    • Updated engine documentation to reflect v7's TypeScript-based default and Rust binary changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 16, 2025

Walkthrough

This PR standardizes MDX admonition block syntax across Prisma ORM documentation, adds Prisma v7 compatibility annotations throughout reference materials, and substantially revises the engines documentation to reflect v7's default Rust-free architecture with TypeScript-based query compilation.

Changes

Cohort / File(s) Change Summary
MDX Syntax Standardization
content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/140-debugging.mdx, content/200-orm/500-reference/200-prisma-cli-reference.mdx
Converts custom Admonition blocks to standard Markdown info/warning syntax (:::info, :::warning). Removes explicit closing tags and reorganizes surrounding structure. Adds debugging examples section with bash/Windows environment variable configuration snippets.
Prisma v7 Deprecation Notices
content/200-orm/500-reference/200-prisma-cli-reference.mdx, content/200-orm/500-reference/300-environment-variables-reference.mdx
Introduces "(Not supported in Prisma ORM v7)" inline annotations across CLI options and environment variables. Adds danger/warning blocks for deprecated environment variables (PRISMA_GENERATE_SKIP_AUTOINSTALL, PRISMA_SKIP_POSTINSTALL_GENERATE, PRISMA_CLI_QUERY_ENGINE_TYPE, PRISMA_*_ENGINE_BINARY, etc.). Updates version constraint language throughout.
Engine Documentation Overhaul
content/200-orm/800-more/100-under-the-hood/100-engines.mdx
Restructures engines documentation to emphasize Prisma ORM v7's default Rust-free, TypeScript-based query compiler architecture. Removes Rust-engine-centric framing; adds prominent warning that v7 is Rust-binary-free by default. Reclassifies Rust-based engines as legacy/optional. Updates configuration sections, environment variable guidance, and CLI examples to reflect new defaults. Demotes engineType configuration as largely historical.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • engines.mdx requires focused attention: Verify all architectural claims about v7's TypeScript-default engine are accurate; ensure legacy Rust-engine guidance is properly scoped and not overstated as deprecated.
  • Deprecation accuracy: Cross-check all "(Not supported in Prisma ORM v7)" annotations against actual v7 behavior; confirm environment variable removals are complete.
  • Environment variables reference: Ensure version constraints (e.g., "6.19 and earlier") are correct and that danger blocks correctly identify all truly removed variables versus deprecated ones.

Possibly related PRs

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title references clearing removed environment variables for Prisma v7, which directly aligns with the primary changes across all four documentation files updating deprecation notices and v7 compatibility information.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c2671d7 and 8488fbe.

📒 Files selected for processing (4)
  • content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/140-debugging.mdx (1 hunks)
  • content/200-orm/500-reference/200-prisma-cli-reference.mdx (11 hunks)
  • content/200-orm/500-reference/300-environment-variables-reference.mdx (10 hunks)
  • content/200-orm/800-more/100-under-the-hood/100-engines.mdx (7 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: All headings and titles should use sentence case (e.g., "Getting started with Prisma ORM", "Best practices for authentication"), not title case. Exception: Always preserve exact casing for product names including "Prisma Postgres", "Prisma", "Prisma ORM", and "Prisma Data Platform".
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:50-66
Timestamp: 2025-10-08T16:22:57.129Z
Learning: In `.mdx` files, do NOT flag or suggest changes for the following code quality issues even if they represent poor practices: React anti-patterns (using var instead of useState, direct DOM manipulation), missing keys in .map() iterations, non-serializable props in getServerSideProps, unused variables, missing error handling, SQL injection vulnerabilities (unless actively showing how to fix them), insecure cookie settings, missing TypeScript types, PrismaClient instantiation patterns, or any other code quality, security, or performance issues. Documentation code snippets are copied from source code and often intentionally show "before" examples or common mistakes.
Learnt from: ankur-arch
Repo: prisma/docs PR: 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.
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7157
File: content/800-guides/400-deno-integration.mdx:188-190
Timestamp: 2025-10-03T19:30:57.554Z
Learning: For the prisma/docs repository, do not suggest changes to code blocks when reviewing documentation pull requests.
Learnt from: carlagn
Repo: prisma/docs PR: 7183
File: content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx:561-567
Timestamp: 2025-10-14T11:41:08.844Z
Learning: Ignore the file `content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx` in future reviews as per user request. Issues in this file were addressed in PR #7185.
📚 Learning: 2025-10-08T16:23:00.388Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.

Applied to files:

  • content/200-orm/500-reference/200-prisma-cli-reference.mdx
  • content/200-orm/500-reference/300-environment-variables-reference.mdx
  • content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/140-debugging.mdx
📚 Learning: 2025-10-08T16:22:57.129Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:50-66
Timestamp: 2025-10-08T16:22:57.129Z
Learning: In `.mdx` files, do NOT flag or suggest changes for the following code quality issues even if they represent poor practices: React anti-patterns (using var instead of useState, direct DOM manipulation), missing keys in .map() iterations, non-serializable props in getServerSideProps, unused variables, missing error handling, SQL injection vulnerabilities (unless actively showing how to fix them), insecure cookie settings, missing TypeScript types, PrismaClient instantiation patterns, or any other code quality, security, or performance issues. Documentation code snippets are copied from source code and often intentionally show "before" examples or common mistakes.

Applied to files:

  • content/200-orm/500-reference/200-prisma-cli-reference.mdx
  • content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/140-debugging.mdx
📚 Learning: 2025-10-08T16:23:00.388Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: All headings and titles should use sentence case (e.g., "Getting started with Prisma ORM", "Best practices for authentication"), not title case. Exception: Always preserve exact casing for product names including "Prisma Postgres", "Prisma", "Prisma ORM", and "Prisma Data Platform".

Applied to files:

  • content/200-orm/500-reference/200-prisma-cli-reference.mdx
📚 Learning: 2025-08-11T09:40:55.237Z
Learnt from: ankur-arch
Repo: prisma/docs PR: 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.

Applied to files:

  • content/200-orm/500-reference/200-prisma-cli-reference.mdx
  • content/200-orm/500-reference/300-environment-variables-reference.mdx
  • content/200-orm/800-more/100-under-the-hood/100-engines.mdx
📚 Learning: 2025-10-09T21:32:50.340Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7167
File: content/900-ai/prompts/astro.mdx:84-84
Timestamp: 2025-10-09T21:32:50.340Z
Learning: The `npx prisma init` command supports the following flags: `--db` (shorthand for `--datasource-provider prisma+postgres`), `--output` (specifies output location for generated client), `--generator-provider` (defines the generator provider), `--datasource-provider`, `--url`, `--preview-feature`, and `--with-model`. These are documented valid CLI options for Prisma init command.

Applied to files:

  • content/200-orm/500-reference/200-prisma-cli-reference.mdx
  • content/200-orm/500-reference/300-environment-variables-reference.mdx
🪛 LanguageTool
content/200-orm/500-reference/300-environment-variables-reference.mdx

[style] ~68-~68: To form a complete sentence, be sure to include a subject.
Context: ...::: PRISMA_GENERATE_SKIP_AUTOINSTALL can be set to a truthy value to skip the au...

(MISSING_IT_THERE)


[style] ~100-~100: To form a complete sentence, be sure to include a subject.
Context: ....2.0 ::: PRISMA_GENERATE_NO_ENGINE` can be set to a truthy value to generate a ...

(MISSING_IT_THERE)


[style] ~100-~100: Consider a more concise word here.
Context: ...gine](/orm/more/under-the-hood/engines) in order to reduce deployed application size when p...

(IN_ORDER_TO_PREMIUM)

content/200-orm/800-more/100-under-the-hood/100-engines.mdx

[style] ~53-~53: Consider a more concise word here.
Context: ...sma Client connects to the query engine in order to read and write data in a database: ![P...

(IN_ORDER_TO_PREMIUM)

⏰ 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). (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (11)
content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/140-debugging.mdx (1)

15-19: Admonition block conversion looks good.

The conversion from custom Admonition syntax to the standard :::info markdown format is clean and maintains the content's intent. The referenced link to the logging documentation is helpful for readers seeking more details.

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

380-386: Deprecation warning format is clear and follows the new standard.

The :::warning block with the deprecation notice is properly formatted and makes it immediately clear that --data-proxy and --accelerate are deprecated in favor of --no-engine. This helps guide users toward the recommended approach.


678-703: v7 compatibility annotations are systematic and helpful.

The inline annotations marking environment variables as "(Not supported in Prisma ORM v7)" are consistently applied and provide clear guidance on which settings won't work in the target version. This prevents users from debugging issues caused by setting deprecated variables. The grouping by category (Query Engine Type, custom engines, postinstall hooks, etc.) makes the information easy to scan.

content/200-orm/500-reference/300-environment-variables-reference.mdx (2)

62-66: v7 deprecation notices establish a clear pattern for version migration.

The :::danger blocks for Prisma v7 removals follow a consistent template: "This environment variable is only supported in Prisma 6.19 and earlier." This message is unambiguous and helps users understand both the scope (affects v7 only) and the boundary (6.19 is the last supported version). The grouping of these deprecations makes it easy to scan which variables won't port forward.

Also applies to: 72-76, 88-98


146-150: Deprecation scope is comprehensive across engine-related variables.

All the environment variables related to Rust query engine configuration (PRISMA_CLI_QUERY_ENGINE_TYPE, PRISMA_CLIENT_ENGINE_TYPE, PRISMA_QUERY_ENGINE_BINARY, PRISMA_QUERY_ENGINE_LIBRARY, PRISMA_INTROSPECTION_ENGINE_BINARY, PRISMA_CLI_BINARY_TARGETS) are marked as not supported in v7. This aligns well with the learning that Prisma ORM v7 defaults to the TypeScript-based query compiler without Rust engine binaries, and these variables would no longer be applicable. Well done on catching the full scope.

Also applies to: 160-164, 213-217, 233-237, 275-279, 317-321

content/200-orm/800-more/100-under-the-hood/100-engines.mdx (6)

7-18: Lead with the v7 default—this front-loaded warning is excellent UX.

Rather than buried in the middle, you've put the critical information upfront: "Prisma ORM v7 is Rust binary-free by default." The bullet points clearly explain what this means in practice (no Rust binaries, TypeScript-based compilation, driver adapters required). This prevents users from spending time on legacy Rust engine configuration only to discover it doesn't apply to their version. The reference to the modern approach ("Prisma ORM without Rust engines") guides them to the right page immediately.


20-26: Prisma v7 generator context note is helpful for orientation.

The info block clarifying that prisma-client is now the default generator in v7 (outputting TypeScript to a custom directory via the output field) helps users understand why the page structure has shifted. It also provides a smooth transition from "here's what's new" to "here's what Rust-based engines do (for reference)."


28-39: Strategic reframing positions legacy content correctly.

By reclassifying the Rust-based engine discussion as describing a "legacy approach" and listing specific use cases (legacy prisma-client-js users, explicit engineType setters), you've recontextualized the entire page without losing important reference information. This tells readers: "This architecture still exists, but it's optional and for specific scenarios." Much better than leaving them to wonder if this page is still relevant.


43-47: Consistent warning blocks prevent legacy-as-current confusion.

Every section describing Rust engine internals, configuration, or use is prefaced with a warning: "This section applies only to Rust-based engines. Prisma ORM v7 defaults to the TypeScript-based query compiler without Rust engine binaries." This consistency ensures that even readers skimming for a specific detail won't accidentally apply Rust-based guidance to their v7 setup. Well organized.

Also applies to: 59-63, 80-93, 183-187, 198-202, 212-216, 245-249, 261-265, 285-289


74-75: Environment variable deprecation notes are precise.

Inline callouts like "Not supported in Prisma ORM v7" next to specific variables (PRISMA_QUERY_ENGINE_LIBRARY, PRISMA_QUERY_ENGINE_BINARY, PRISMA_INTROSPECTION_ENGINE_BINARY) and the warning blocks for PRISMA_CLIENT_ENGINE_TYPE and PRISMA_CLI_QUERY_ENGINE_TYPE make the v7 incompatibilities explicit. Users won't waste time trying to configure removed variables. This aligns well with the learning that v7's TypeScript-based compilation removes the need for these Rust engine controls.

Also applies to: 78-79, 84-85, 307-310, 324-327


312-318: Historical context box provides useful perspective.

The "Historical context" section tracing the evolution from binary-only (until 3.x) → library default (from 2.20.0–3.x, via preview flag) → v7 TypeScript-based default helps readers understand why engineType existed and why it's no longer needed. This pedagogical touch transforms dry deprecation notices into an understandable narrative of architectural evolution.


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

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 16, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8488fbe
Status: ✅  Deploy successful!
Preview URL: https://5d3375c5.docs-51g.pages.dev
Branch Preview URL: https://dc-6204.docs-51g.pages.dev

View logs

@github-actions
Copy link
Contributor

Dangerous URL check

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

@github-actions
Copy link
Contributor

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.

@ankur-arch ankur-arch self-assigned this Nov 16, 2025
@ankur-arch ankur-arch merged commit 32e3082 into prisma-7 Nov 17, 2025
6 checks passed
@ankur-arch ankur-arch deleted the DC-6204 branch November 17, 2025 08:49
aidankmcalister pushed a commit that referenced this pull request Nov 18, 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