Skip to content

Conversation

@ankur-arch
Copy link
Contributor

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

Summary by CodeRabbit

  • Documentation

    • Updated Prisma config examples and wording to consistently load .env variables (some examples added, others streamlined/removed)
    • Added multiple error-reference pages that redirect to relevant ORM/Migrate docs
    • Added new site redirects for getting-started and error-reference routes
    • Added a limitation note about connection pooling for the serverless driver
  • Bug Fixes

    • Improved doc listing behavior to exclude hidden-sidebar items from related lists

✏️ Tip: You can customize this high-level summary in your review settings.

@ankur-arch ankur-arch self-assigned this Nov 19, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 19, 2025

Walkthrough

Standardizes dotenv usage and adjusts prisma.config.ts examples across many docs (adding, reordering, or removing import 'dotenv/config'), adds several error-reference redirect pages and static redirect mappings, replaces external error links with internal ones, and adds a serverless driver limitation note. (45 words)

Changes

Cohort / File(s) Summary
Quickstart prisma.config.ts examples
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx, .../200-sqlite.mdx, .../300-postgresql.mdx, .../400-mysql.mdx, .../500-sql-server.mdx, .../600-planetscale.mdx, .../700-cockroachdb.mdx
Added or moved import 'dotenv/config' in prisma.config.ts snippets (various positions: before Prisma imports or reordered); removed instructional markers in some snippets.
Add-to-existing-project prisma.config.ts examples
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/100-prisma-postgres.mdx, .../200-sqlite.mdx, .../300-postgresql.mdx, .../400-mysql.mdx, .../500-sql-server.mdx, .../600-planetscale.mdx, .../700-cockroachdb.mdx
Mixed edits: some files gained import 'dotenv/config' (placed before Prisma config imports); others had the dotenv snippet or generated inline config removed.
From-the-CLI / narrative updates
content/100-getting-started/03-prisma-postgres/100-from-the-cli.mdx, content/100-getting-started/03-prisma-postgres/100-quickstart/50-prisma-orm.mdx
Reworded to indicate prisma.config.ts is generated; removed manual config code blocks and add-start/add-end instructional markers.
Error-reference link changes
content/200-orm/500-reference/250-error-reference.mdx
Replaced external Prism.ly links with internal documentation links for multiple error entries; minor formatting adjustments.
Added redirect MDX pages (error reference)
content/200-orm/500-reference/300-errors/*
New MDX files (connection-pool.mdx, migrate*.mdx, mongodb-replica-set.mdx, etc.) with frontmatter and client-side Redirect components forwarding to canonical docs/anchors.
Serverless driver note
content/250-postgres/300-database/750-serverless-driver.mdx
Added a Limitations note stating connection pooling is not currently supported.
Guides wording and next-steps
content/800-guides/050-migrate-from-mongoose.mdx, content/800-guides/370-bun.mdx
Minor wording changes and updated next-steps links/bullets; no code changes.
Static redirects
static/_redirects
Added multiple redirect mappings (error-reference targets and a getting-started mapping) and inserted marker "### NO REDIRECTS BELOW THIS LINE..."
Sidebar rendering filter
src/theme/DocCardList/index.tsx
Updated effect to filter out doc cards matching current pathname and also those with className: "hidden-sidebar".
Category metadata
content/200-orm/500-reference/300-errors/_category_.json
Added { "className": "hidden-sidebar" }.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Changes are mostly repetitive documentation edits and new redirect pages, with a small UI tweak in DocCardList.
  • Pay attention to:
    • Consistent placement of import 'dotenv/config' (before any env-using Prisma config) and TypeScript validity of samples.
    • Validity and absence of redirect conflicts for static/_redirects and correct Redirect targets in new MDX files.
    • Correct internal targets/anchors in updated error-reference links.

Possibly related PRs

Pre-merge checks

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Title check ❓ Inconclusive The title 'fix: clean-up from prisma 7' is vague and generic, using non-descriptive terms that don't convey the specific nature of the changes made across the documentation. Consider a more specific title that highlights the main changes, such as 'fix: add dotenv import to prisma.config.ts examples and update error reference redirects' to better communicate the scope of this cleanup.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

@github-actions
Copy link
Contributor

Dangerous URL check

Absolute URLs

The following files have absolute URLs to prisma.io/docs. Please replace them with relative URLs.
Example: https://www.prisma.io/docs/getting-started/quickstart -> /getting-started/quickstart
content/250-postgres/300-database/750-serverless-driver.mdx

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.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 19, 2025

original preview
content/200-orm/500-reference/300-errors/connection-pool.mdx content/200-orm/500-reference/300-errors/connection-pool.mdx
content/200-orm/500-reference/300-errors/migrate-baseline.mdx content/200-orm/500-reference/300-errors/migrate-baseline.mdx
content/200-orm/500-reference/300-errors/migrate-no-direct-ddl.mdx content/200-orm/500-reference/300-errors/migrate-no-direct-ddl.mdx
content/200-orm/500-reference/300-errors/migrate-no-foreign-keys.mdx content/200-orm/500-reference/300-errors/migrate-no-foreign-keys.mdx
content/200-orm/500-reference/300-errors/migrate-provider-switch.mdx content/200-orm/500-reference/300-errors/migrate-provider-switch.mdx
content/200-orm/500-reference/300-errors/migrate-resolve.mdx content/200-orm/500-reference/300-errors/migrate-resolve.mdx
content/200-orm/500-reference/300-errors/migrate-shadow.mdx content/200-orm/500-reference/300-errors/migrate-shadow.mdx
content/200-orm/500-reference/300-errors/migrate.mdx content/200-orm/500-reference/300-errors/migrate.mdx
content/200-orm/500-reference/300-errors/mongodb-replica-set.mdx content/200-orm/500-reference/300-errors/mongodb-replica-set.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/300-postgresql.mdx content/100-getting-started/02-prisma-orm/100-quickstart/300-postgresql.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/400-mysql.mdx content/100-getting-started/02-prisma-orm/100-quickstart/400-mysql.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/500-sql-server.mdx content/100-getting-started/02-prisma-orm/100-quickstart/500-sql-server.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/600-planetscale.mdx content/100-getting-started/02-prisma-orm/100-quickstart/600-planetscale.mdx
content/100-getting-started/02-prisma-orm/100-quickstart/700-cockroachdb.mdx content/100-getting-started/02-prisma-orm/100-quickstart/700-cockroachdb.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/100-prisma-postgres.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/100-prisma-postgres.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/300-postgresql.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/300-postgresql.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/400-mysql.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/400-mysql.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/500-sql-server.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/500-sql-server.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/600-planetscale.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/600-planetscale.mdx
content/100-getting-started/02-prisma-orm/200-add-to-existing-project/700-cockroachdb.mdx content/100-getting-started/02-prisma-orm/200-add-to-existing-project/700-cockroachdb.mdx
content/100-getting-started/03-prisma-postgres/100-from-the-cli.mdx content/100-getting-started/03-prisma-postgres/100-from-the-cli.mdx
content/100-getting-started/03-prisma-postgres/100-quickstart/50-prisma-orm.mdx content/100-getting-started/03-prisma-postgres/100-quickstart/50-prisma-orm.mdx
content/200-orm/500-reference/250-error-reference.mdx content/200-orm/500-reference/250-error-reference.mdx
content/250-postgres/300-database/750-serverless-driver.mdx content/250-postgres/300-database/750-serverless-driver.mdx
content/800-guides/050-migrate-from-mongoose.mdx content/800-guides/050-migrate-from-mongoose.mdx
content/800-guides/370-bun.mdx content/800-guides/370-bun.mdx

@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status Count
🔍 Total 2236
✅ Successful 2200
⏳ Timeouts 0
🔀 Redirected 3
👻 Excluded 23
❓ Unknown 0
🚫 Errors 9
⛔ Unsupported 1

Errors per input

Errors in 200-orm/500-reference/250-error-reference.mdx

Errors in 800-guides/050-migrate-from-mongoose.mdx

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

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

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 48b7a74
Status: ✅  Deploy successful!
Preview URL: https://ef54063f.docs-51g.pages.dev
Branch Preview URL: https://patch-ankur-docs.docs-51g.pages.dev

View logs

ArthurGamby
ArthurGamby previously approved these changes Nov 19, 2025
mhartington
mhartington previously approved these changes Nov 19, 2025
@aidankmcalister
Copy link
Member

@ankur-arch There are some failing pris.ly links. Could fixes for those be included in this PR?

@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status Count
🔍 Total 2236
✅ Successful 2198
⏳ Timeouts 0
🔀 Redirected 3
👻 Excluded 23
❓ Unknown 0
🚫 Errors 11
⛔ Unsupported 1

Errors per input

Errors in 200-orm/500-reference/250-error-reference.mdx

Errors in 800-guides/050-migrate-from-mongoose.mdx

Errors in 800-guides/180-solid-start.mdx

Errors in 800-guides/370-bun.mdx

Arthur Gamby added 2 commits November 20, 2025 12:51
- Replaces external  shortlinks in  with internal stable paths ().
- Creates client-side redirect pages for error codes to support local development and ensure link stability.
- Updates  to include server-side rules for the new error paths.
- Preserves the visual display of  links in error messages for fidelity with CLI output.

Ref: P2024, P3003, P3005, P3009, P3014, P3018, P3019, P3020, P3021, P3022, P2031
@ArthurGamby ArthurGamby dismissed stale reviews from coderabbitai[bot], mhartington, and themself via cffd534 November 20, 2025 11:56
@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status Count
🔍 Total 2225
✅ Successful 2198
⏳ Timeouts 0
🔀 Redirected 2
👻 Excluded 23
❓ Unknown 0
🚫 Errors 1
⛔ Unsupported 1

Errors per input

Errors in 200-orm/500-reference/250-error-reference.mdx

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 20, 2025
@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status Count
🔍 Total 2224
✅ Successful 2198
⏳ Timeouts 0
🔀 Redirected 2
👻 Excluded 23
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 1

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 20, 2025
@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status Count
🔍 Total 2224
✅ Successful 2196
⏳ Timeouts 0
🔀 Redirected 2
👻 Excluded 23
❓ Unknown 0
🚫 Errors 2
⛔ Unsupported 1

Errors per input

Errors in 800-guides/220-astro.mdx

Errors in 800-guides/400-betterauth-astro.mdx

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

📜 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 8cfea05 and 3f4b0ef.

📒 Files selected for processing (2)
  • content/200-orm/500-reference/300-errors/_category_.json (1 hunks)
  • src/theme/DocCardList/index.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • content/200-orm/500-reference/300-errors/category.json
🧰 Additional context used
🧠 Learnings (1)
📓 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.
🧬 Code graph analysis (1)
src/theme/DocCardList/index.tsx (1)
src/theme/DocItem/Content/index.js (1)
  • location (30-30)
⏰ 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). (2)
  • GitHub Check: Check internal links
  • GitHub Check: Cloudflare Pages

@mhessdev mhessdev merged commit e8d4bde into main Nov 20, 2025
7 of 8 checks passed
@mhessdev mhessdev deleted the patch-ankur-docs branch November 20, 2025 14:05
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.

6 participants