Skip to content

docs(compute): update Alchemy provider guide - #8121

Merged
AmanVarshney01 merged 9 commits into
mainfrom
aman/update-alchemy-docs
Aug 4, 2026
Merged

docs(compute): update Alchemy provider guide#8121
AmanVarshney01 merged 9 commits into
mainfrom
aman/update-alchemy-docs

Conversation

@AmanVarshney01

@AmanVarshney01 AmanVarshney01 commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

  • move the Alchemy guide under Compute now that the provider covers Prisma Postgres and Prisma Compute
  • replace the Postgres-only guide with an end-to-end setup, authentication, deployment, database, production, and cleanup workflow
  • redirect the previous Postgres IaC URL to the Compute guide

Validation

  • pnpm --filter docs types:check
  • pnpm --filter docs lint:links
  • pnpm --filter docs audit:redirects

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Alchemy guide for provisioning Prisma Postgres and deploying applications to Prisma Compute.
    • Documented authentication, local development, production deployments, custom domains, CI workflows, migrations, health checks, and cleanup.
    • Moved the Alchemy integration documentation to the Compute section with updated navigation.
    • Added a permanent redirect from the previous documentation path to the new location.

@vercel

vercel Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview Aug 4, 2026 12:44pm
docs Ready Ready Preview Aug 4, 2026 12:44pm
eclipse Ready Ready Preview Aug 4, 2026 12:44pm
site Ready Ready Preview Aug 4, 2026 12:44pm

Request Review

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 918c7ec7-30b3-473a-b4e5-dc6cc473f83e

📥 Commits

Reviewing files that changed from the base of the PR and between de801f1 and 8640cfe.

📒 Files selected for processing (1)
  • apps/docs/content/docs/compute/alchemy.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/docs/compute/alchemy.mdx

Walkthrough

Added a complete Alchemy guide for Prisma Compute and Prisma Postgres. Updated documentation navigation and added a permanent redirect from the previous Postgres Alchemy route.

Changes

Alchemy documentation

Layer / File(s) Summary
Compute Alchemy setup and provisioning
apps/docs/content/docs/compute/alchemy.mdx
Documents installation, authentication, stack provisioning, database configuration, and migration settings.
Deployment and environment workflows
apps/docs/content/docs/compute/alchemy.mdx
Documents deployment commands, local development, production settings, CI cleanup, teardown behavior, and API references.
Navigation and route migration
apps/docs/content/docs/compute/meta.json, apps/docs/content/docs/postgres/iac/meta.json, apps/docs/vercel.json
Adds the guide to Compute navigation, removes the previous Postgres navigation entry, and permanently redirects the old route.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Suggested reviewers: ankur-arch

🚥 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 clearly identifies the documentation update and the Compute Alchemy guide, which matches the primary changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch aman/update-alchemy-docs

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

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

18 links: ✅ 17 OK | 🚫 0 errors | 🔀 0 redirects | 👻 1 excluded

✅ All links are working!


Full Statistics Table
Status Count
✅ Successful 17
🔀 Redirected 0
👻 Excluded 1
🚫 Errors 0
⛔ Unsupported 0
⏳ Timeouts 0
❓ Unknown 0

@argos-ci

argos-ci Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Aug 4, 2026, 12:51 PM

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
apps/docs/content/docs/compute/alchemy.mdx (1)

19-22: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Use the docs package-manager command tabs.

These terminal sequences use Bun-only bash fences. Use npm fenced blocks for package-manager-independent commands so the docs tooling renders Bun, npm, pnpm, and Yarn variants.

  • apps/docs/content/docs/compute/alchemy.mdx#L19-L22: Use an npm fence for installation.
  • apps/docs/content/docs/compute/alchemy.mdx#L28-L30: Use an npm fence for authentication.
  • apps/docs/content/docs/compute/alchemy.mdx#L88-L91: Use an npm fence for deployment.
  • apps/docs/content/docs/compute/alchemy.mdx#L97-L100: Use an npm fence for subsequent deployments.
  • apps/docs/content/docs/compute/alchemy.mdx#L169-L171: Use an npm fence for local development.
  • apps/docs/content/docs/compute/alchemy.mdx#L208-L211: Use an npm fence for CI deployment and cleanup.

Based on learnings: The docs tooling converts an npm fenced block into package-manager tabs automatically.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/docs/content/docs/compute/alchemy.mdx` around lines 19 - 22, Replace the
Bun-only bash fences with npm fences for the package-manager commands in
apps/docs/content/docs/compute/alchemy.mdx at lines 19-22 (installation), 28-30
(authentication), 88-91 (deployment), 97-100 (subsequent deployments), 169-171
(local development), and 208-211 (CI deployment and cleanup), preserving each
command sequence so the docs tooling generates Bun, npm, pnpm, and Yarn tabs.

Source: Learnings

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/content/docs/compute/alchemy.mdx`:
- Around line 208-211: Update the CI command example in the Alchemy
documentation to deploy and destroy an ephemeral preview stage rather than prod.
Use the same non-production stage consistently for both commands, and explicitly
state that cleanup must never target the prod stage.
- Line 90: Remove the hard-coded https:// prefix from both curl commands in
apps/docs/content/docs/compute/alchemy.mdx at lines 90 and 99, using the full
URL from the stack output directly because app.url already includes the scheme.
- Around line 82-84: Update the migration guidance near the Compute database
provisioning note to explicitly state that Prisma CLI migrations should map
connection.directConnectionString to datasource.url in prisma.config.ts, while
connection.databaseUrl remains the application runtime URL; note that Prisma ORM
7 reads the migration URL from prisma.config.ts.

---

Nitpick comments:
In `@apps/docs/content/docs/compute/alchemy.mdx`:
- Around line 19-22: Replace the Bun-only bash fences with npm fences for the
package-manager commands in apps/docs/content/docs/compute/alchemy.mdx at lines
19-22 (installation), 28-30 (authentication), 88-91 (deployment), 97-100
(subsequent deployments), 169-171 (local development), and 208-211 (CI
deployment and cleanup), preserving each command sequence so the docs tooling
generates Bun, npm, pnpm, and Yarn tabs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6c484d96-fd70-458d-bdb0-319e5b3d759d

📥 Commits

Reviewing files that changed from the base of the PR and between 26c17ab and 0e5e15d.

📒 Files selected for processing (5)
  • apps/docs/content/docs/compute/alchemy.mdx
  • apps/docs/content/docs/compute/meta.json
  • apps/docs/content/docs/postgres/iac/alchemy.mdx
  • apps/docs/content/docs/postgres/iac/meta.json
  • apps/docs/vercel.json
💤 Files with no reviewable changes (1)
  • apps/docs/content/docs/postgres/iac/alchemy.mdx

Comment thread apps/docs/content/docs/compute/alchemy.mdx Outdated
Comment thread apps/docs/content/docs/compute/alchemy.mdx Outdated
Comment thread apps/docs/content/docs/compute/alchemy.mdx Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/content/docs/postgres/iac/meta.json`:
- Line 3: Restore Alchemy discoverability in the Postgres IaC navigation by
updating the pages array in the metadata object to include a
documentation-renderer-supported cross-link pointing to /docs/compute/alchemy,
while preserving the existing Terraform and Pulumi entries.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: fcbd34e8-296d-417e-9520-bc8a4336b31b

📥 Commits

Reviewing files that changed from the base of the PR and between 0e5e15d and b9477ed.

📒 Files selected for processing (1)
  • apps/docs/content/docs/postgres/iac/meta.json

Comment thread apps/docs/content/docs/postgres/iac/meta.json

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/content/docs/compute/alchemy.mdx`:
- Line 21: Update the command adding `.alchemy/` to `.gitignore` to ensure a
newline separates it from any existing final entry, including when the file
lacks a trailing newline, while preserving the intended ignore pattern.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 543af027-ddcc-4c7e-984d-2c456ef4e4d3

📥 Commits

Reviewing files that changed from the base of the PR and between b9477ed and de801f1.

📒 Files selected for processing (1)
  • apps/docs/content/docs/compute/alchemy.mdx

Comment thread apps/docs/content/docs/compute/alchemy.mdx Outdated
@AmanVarshney01
AmanVarshney01 merged commit 35d559e into main Aug 4, 2026
18 checks passed
@AmanVarshney01
AmanVarshney01 deleted the aman/update-alchemy-docs branch August 4, 2026 13:02
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