Skip to content

docs(docs): align PostgreSQL quickstart prisma.config.ts with init output#7826

Open
nielskaspers wants to merge 1 commit intoprisma:mainfrom
nielskaspers:docs/issue-7818-prisma-init-quickstart
Open

docs(docs): align PostgreSQL quickstart prisma.config.ts with init output#7826
nielskaspers wants to merge 1 commit intoprisma:mainfrom
nielskaspers:docs/issue-7818-prisma-init-quickstart

Conversation

@nielskaspers
Copy link
Copy Markdown

@nielskaspers nielskaspers commented Apr 26, 2026

Summary

Updates the prisma.config.ts snippet in the PostgreSQL quickstart so it matches what npx prisma init --datasource-provider postgresql --output ../generated/prisma actually generates today.

Issue

Closes #7818

Changes

  • apps/docs/content/docs/(index)/prisma-orm/quickstart/postgresql.mdx:
    • Add the two leading // This file was generated by Prisma... comments emitted by prisma init
    • Drop the env named import from prisma/config (no longer included)
    • Use process.env["DATABASE_URL"] instead of env("DATABASE_URL")

Notes

The same prisma.config.ts block appears in the other quickstart pages (sqlite, mysql, mongodb, sql-server, planetscale, cockroachdb, prisma-postgres). Happy to extend the PR to those files in a follow-up commit if maintainers prefer — kept this one scoped to the file referenced in the issue.

Testing

Docs-only change. Snippet content compared against the output of prisma init reported by the issue author.

Summary by CodeRabbit

  • Documentation
    • Updated PostgreSQL quickstart guide with streamlined configuration examples and clarified dependency requirements.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 26, 2026

@nielskaspers is attempting to deploy a commit to the Prisma Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 83de4315-9a63-4cea-90a1-bad270aae8f3

📥 Commits

Reviewing files that changed from the base of the PR and between 86e9c4d and 06e8819.

📒 Files selected for processing (1)
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/postgresql.mdx

Walkthrough

Documentation example for prisma.config.ts in the PostgreSQL quickstart guide is updated to replace Prisma's env() helper with direct process.env["DATABASE_URL"] reference and add installation requirement comments, aligning the docs with the actual output of the prisma init command.

Changes

Cohort / File(s) Summary
PostgreSQL Quickstart Documentation
apps/docs/content/docs/(index)/prisma-orm/quickstart/postgresql.mdx
Updated prisma.config.ts code example to use process.env["DATABASE_URL"] instead of env("DATABASE_URL"), removed the env import from prisma/config, and added a comment indicating that prisma and dotenv are expected dev dependencies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: updating the PostgreSQL quickstart documentation to align the prisma.config.ts example with the current output of the prisma init command.
Linked Issues check ✅ Passed The PR successfully addresses all coding-related requirements from issue #7818: adds generated-file comments, removes the env import, and replaces env() calls with process.env[] access.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the stated objective of aligning the PostgreSQL quickstart documentation with actual prisma init output; no extraneous modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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.

prisma init ... command generates different output, than what is shown in the docs

1 participant