Skip to content

Misc doc updates#7118

Merged
nikolasburk merged 5 commits intomainfrom
docs/misc
Sep 11, 2025
Merged

Misc doc updates#7118
nikolasburk merged 5 commits intomainfrom
docs/misc

Conversation

@nikolasburk
Copy link
Contributor

@nikolasburk nikolasburk commented Sep 11, 2025

Summary by CodeRabbit

  • Documentation
    • Generators: Adjusted heading levels, added “Breaking changes from prisma-client-js” guidance (generator output path required; prefer TypeScript’s satisfies), and updated browser import example to use the browser-specific bundle.
    • Postgres Extensions: Reworked overview and availability messaging, added plan/instance-based availability details, published a comprehensive supported-extensions catalog, and clarified limited Studio support with example error messaging for unsupported extension types.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 11, 2025

Walkthrough

Docs updates: generators doc adds breaking-changes notes and adjusts browser import heading/path; Postgres extensions doc is expanded and reorganized with Limited-availability details, Studio limitations/error example, and a comprehensive supported-extensions catalog. (49 words)

Changes

Cohort / File(s) Summary of changes
Generators doc updates
content/200-orm/100-prisma-schema/10-overview/03-generators.mdx
- Demoted “Importing in browser environments” from H3 to H4
- Added two “Breaking changes from prisma-client-js” sections stating: generator now requires an output path; Prisma.validator removed (use TS satisfies).
- Updated browser import example to reference ./generated/prisma/browser (browser bundle)
Postgres extensions doc revamp
content/250-postgres/300-database/525-postgres-extensions.mdx
- Reworded overview and added link to full supported-extensions list and feedback form
- Introduced “Limited availability of extensions” guidance with plan/date specifics and rollout note
- Replaced pgvector-specific temp-limits note with extension-wide Studio limitations and added a Prisma Studio error example for unsupported extension types
- Added comprehensive “All supported extensions” list (expanded/corrected) and removed duplicates from prior lists
- Miscellaneous text/typography adjustments

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • ankur-arch
  • mhessdev
  • nurul3101
  • petradonka

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Pre-merge checks (2 passed, 1 inconclusive)

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The current title "Misc doc updates" is overly generic and does not summarize the primary changes in this PR; the raw summary shows distinct, substantive edits including adding "Breaking changes from prisma-client-js" and browser import notes in the generators doc plus a large expansion and restructuring of the Postgres extensions documentation. Because the title fails to identify these main changes, it does not clearly communicate the PR scope to reviewers. Therefore the title is inconclusive for review purposes. Please rename the PR to a concise, specific title that highlights the main change(s). For example, "Docs: Add Prisma Client breaking-changes note and expand Postgres extensions list" or "Docs: Update browser generator import and add comprehensive Postgres extensions docs". Update the title before merging so reviewers can quickly understand the PR scope.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/misc

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

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

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: 1

🧹 Nitpick comments (4)
content/200-orm/100-prisma-schema/10-overview/03-generators.mdx (2)

195-204: Browser import path change looks good; add one-sentence clarity

Consider explicitly stating “browser only exports types” inline to reduce confusion.

-Note that `./generated/prisma/browser` does not expose a `PrismaClient`.
+Note that `./generated/prisma/browser` only exports types and does not expose a `PrismaClient`.

275-279: Breaking changes section: great addition; add migration pointer

Add a short pointer to a migration/upgrade guide from prisma-client-js to prisma-client to help readers act on these bullets.

 ### Breaking changes from `prisma-client-js`

 - Requires an `output` path on the `generator` block
 - No `Prisma.validator` function;  you can use TypeScript native [`satisfies`](https://www.prisma.io/blog/satisfies-operator-ur8ys8ccq7zb) keyword instead
+  
+For step-by-step guidance, see the upgrade guide from `prisma-client-js` → `prisma-client` (link).
content/250-postgres/300-database/525-postgres-extensions.mdx (2)

138-145: Fix typo: “extenssions” → “extensions”

Minor spelling fix in the Studio limitation heading.

-### No Prisma Studio support for special data types from extenssions
+### No Prisma Studio support for special data types from extensions

166-215: Long list maintenance: reduce drift risk

Consider auto-generating or sourcing this list from a single metadata file used by the product/site to prevent future drift and ensure parity with the platform. If auto-gen isn’t feasible, add a “last updated” note.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b776c2 and 025393b.

📒 Files selected for processing (2)
  • content/200-orm/100-prisma-schema/10-overview/03-generators.mdx (2 hunks)
  • content/250-postgres/300-database/525-postgres-extensions.mdx (3 hunks)
⏰ 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: runner / linkspector
  • GitHub Check: Check internal links
  • GitHub Check: Lost Pixel

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 11, 2025
@cloudflare-workers-and-pages
Copy link

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

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 723bfaa
Status: ✅  Deploy successful!
Preview URL: https://b55f6e3f.docs-51g.pages.dev
Branch Preview URL: https://docs-misc.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: 2

♻️ Duplicate comments (1)
content/250-postgres/300-database/525-postgres-extensions.mdx (1)

19-21: Remove “contrib” from the list; it’s not an extension.

“contrib” is a collection of extensions, not a single extension. List individual contrib extensions (which you already do below) and drop this bullet.

 - [`pgcrypto`](https://www.postgresql.org/docs/current/pgcrypto.html)
-- [`contrib`](https://www.postgresql.org/docs/current/contrib.html) extensions
+<!-- Extensions from contrib are listed individually below. -->
🧹 Nitpick comments (3)
content/250-postgres/300-database/525-postgres-extensions.mdx (3)

34-34: Grammar: drop “in” after “via”.

-... send [raw SQL](/orm/prisma-client/using-raw-sql) via in Prisma ORM).
+... send [raw SQL](/orm/prisma-client/using-raw-sql) via Prisma ORM).

111-111: Typo: “You Prisma schema” → “Your Prisma schema”.

-You Prisma schema will now contain the `Document` model:
+Your Prisma schema will now contain the `Document` model:

123-123: Renumber the step heading to 5.

Previous section is “4. Pull…”, so this should be “5. Query…”.

-### 4. Query with raw SQL
+### 5. Query with raw SQL
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 025393b and 899b0b7.

📒 Files selected for processing (1)
  • content/250-postgres/300-database/525-postgres-extensions.mdx (3 hunks)
⏰ 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
🔇 Additional comments (2)
content/250-postgres/300-database/525-postgres-extensions.mdx (2)

22-25: Call-to-action reads well. LGTM.
Clear guidance to the full list and feedback form.


172-223: Annotate/remove deprecated / 3rd‑party extensions in the list

  • intagg — obsolete compatibility wrapper in current PostgreSQL (not recommended for new code).
  • xml2 — deprecated; use core SQL/XML and the xml type.
  • pg_search — third‑party (PGXN), not part of PostgreSQL core/contrib.

Confirm whether Prisma Postgres images actually ship these; if they do not, remove them from content/250-postgres/300-database/525-postgres-extensions.mdx (lines 172–223). If they are shipped, annotate each entry as "deprecated" or "third‑party" and add an external-source link.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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 (2)
content/250-postgres/300-database/525-postgres-extensions.mdx (2)

34-35: Fix grammar: “via in Prisma ORM”.
User-facing docs: correct the duplicated preposition.

-... send [raw SQL](/orm/prisma-client/using-raw-sql) via in Prisma ORM
+... send [raw SQL](/orm/prisma-client/using-raw-sql) via Prisma ORM

109-113: Typo: “You Prisma schema” → “Your Prisma schema”.
User-facing grammar fix.

-You Prisma schema will now contain the `Document` model:
+Your Prisma schema will now contain the `Document` model:
♻️ Duplicate comments (2)
content/250-postgres/300-database/525-postgres-extensions.mdx (2)

140-146: Clarify date and fix grammar in availability section.
Add the year to avoid ambiguity and fix “will received”.

-- _all_ instances on Free and Starter plans created after August 12th
+- _all_ instances on Free and Starter plans created after August 12, 2025
...
-Remaining instances will received support for extensions soon.
+Remaining instances will receive support for extensions soon.

19-21: Remove “contrib” from the extensions list (it’s a collection, not a single extension).

Listing “contrib” as an extension is misleading. Either remove the bullet or rephrase as a note.

 - [`pgcrypto`](https://www.postgresql.org/docs/current/pgcrypto.html)
-- [`contrib`](https://www.postgresql.org/docs/current/contrib.html) extensions
+<!-- Extensions from contrib are listed individually below. -->
🧹 Nitpick comments (2)
content/250-postgres/300-database/525-postgres-extensions.mdx (2)

77-79: Step numbering: duplicate “### 4.” heading.
Second occurrence should be “5” to keep sequence consistent.

-### 4. Query with raw SQL
+### 5. Query with raw SQL

Also applies to: 123-124


174-176: Tone tweak: avoid “corrected URLs” phrasing.
Reads like an internal note; keep user-focused.

-Here’s the full list with corrected URLs:
+Here’s the full list of supported extensions:
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 899b0b7 and 02993ef.

📒 Files selected for processing (1)
  • content/250-postgres/300-database/525-postgres-extensions.mdx (3 hunks)
⏰ 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: runner / linkspector
  • GitHub Check: Check internal links
  • GitHub Check: Lost Pixel
🔇 Additional comments (1)
content/250-postgres/300-database/525-postgres-extensions.mdx (1)

172-223: Validate the “All supported extensions” list against the product allowlist.
Some items (e.g., autoinc/intagg/refint) can vary by Postgres version/distribution. Please confirm parity with what Prisma Postgres actually enables to prevent drift.

Would you like me to generate a quick checklist/script to compare this list with the current allowlist from the service configuration?

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 11, 2025
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

♻️ Duplicate comments (1)
content/250-postgres/300-database/525-postgres-extensions.mdx (1)

19-21: Remove “contrib” as if it were a single extension

“contrib” is a collection of extensions; listing it here is misleading. Replace with a clarifying note.

 - [`pgcrypto`](https://www.postgresql.org/docs/current/pgcrypto.html)
-- [`contrib`](https://www.postgresql.org/docs/current/contrib.html) extensions
+<!-- Extensions from contrib are listed individually below. -->
🧹 Nitpick comments (7)
content/250-postgres/300-database/525-postgres-extensions.mdx (7)

14-14: Use consistent naming: vector vs pgvector

Standardize to the extension name “vector (pgvector)”.

-- [`pgvector`](https://github.com/pgvector/pgvector)
+- [`vector` (pgvector)](https://github.com/pgvector/pgvector)

Also applies to: 221-221


34-34: Fix grammar: “via in” → “in”

Tighten the sentence.

-... or another mechanism to send [raw SQL](/orm/prisma-client/using-raw-sql) via in Prisma ORM). 
+... or another mechanism to send [raw SQL](/orm/prisma-client/using-raw-sql) in Prisma ORM).

111-111: Typo: “You Prisma schema” → “Your Prisma schema”

-You Prisma schema will now contain the `Document` model:
+Your Prisma schema will now contain the `Document` model:

123-123: Step numbering: this should be 5

-### 4. Query with raw SQL
+### 5. Query with raw SQL

140-145: Date style: drop ordinal “th” for consistency

Use “August 12, 2025”.

-- _all_ instances on Free and Starter plans created after August 12th, 2025
+- _all_ instances on Free and Starter plans created after August 12, 2025

174-174: Tone: remove “with corrected URLs” (internal phrasing)

Keep it neutral for readers.

-Here’s the full list with corrected URLs:
+Here’s the full list:

201-201: Verify “pg_search” support; it’s a community extension

Confirm it’s actually available on Prisma Postgres. If not, move it to “Other extensions are coming soon.”

- - [`pg_search`](https://pgxn.org/dist/pg_search/)
+<!-- If not currently available on Prisma Postgres, remove from supported list -->

If unavailable today, also add under “Other extensions are coming soon”:

@@
 Support for the following extensions is going to come soon:
 
 - [`postgis`](https://postgis.net/)
+ - [`pg_search`](https://pgxn.org/dist/pg_search/)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02993ef and 723bfaa.

📒 Files selected for processing (1)
  • content/250-postgres/300-database/525-postgres-extensions.mdx (3 hunks)
⏰ 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: runner / linkspector
  • GitHub Check: Check internal links
  • GitHub Check: Lost Pixel

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.

1 participant