docs(docs): fix Compute production/preview, promote, and framework support docs#8032
Closed
ankur-arch wants to merge 1 commit into
Closed
Conversation
…pport docs Linear: DR-8720 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
🍈 Lychee Link Check Report52 links: ✅ All links are working!Full Statistics Table
|
Contributor
WalkthroughDocumentation across Prisma Compute pages was updated to clarify that production versus preview environments are resolved from branch context ( ChangesCompute Documentation Updates
Estimated code review effort: 2 (Simple) | ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
apps/docs/content/docs/compute/limitations.mdx (1)
20-25: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win"production and default branches" implies two distinct concepts.
Per this file's own line 20, the production branch is the default branch. "left alone" phrasing on line 24 reads as if these could differ.
✏️ Suggested tweak
-- Deleting a branch on GitHub can tear down the matching platform branch, but production and default branches are always left alone. +- Deleting a branch on GitHub can tear down the matching platform branch, but the production (default) branch is always left alone.🤖 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/limitations.mdx` around lines 20 - 25, Clarify the wording in the limitations copy so “production branch” and “default branch” are not treated as separate concepts, since the text already says the production branch is the default branch. Update the relevant sentences in the documentation content to use one consistent term or explicitly say “production/default branch” where needed, and keep the behavior notes for app deploy, app promote, branch list, and branch deletion aligned with that single definition.
🤖 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/deployments.mdx`:
- Around line 121-135: The “Promote and roll back” section in deployments.mdx
should be made branch-neutral because the current wording in the `app promote`
example and surrounding text implies only production deployments and production
environment variables. Update the prose around `app promote` so it matches the
branch-scoped behavior described later in the same section and in the `app
promote` documentation: make clear it rebuilds using the current branch’s
environment variables (production on the production branch, preview on preview
branches) and still note that the rebuild is required before verifying the live
result.
In `@apps/docs/content/docs/compute/limitations.mdx`:
- Around line 28-30: Clarify the framework support wording in the limitations
doc so it does not imply that all accepted `app deploy --framework` values are
dedicated framework integrations. Update the copy near the `app deploy
--framework` and `app build --build-type` descriptions in the limitations
content to distinguish the dedicated frameworks from the generic fallback values
(`bun` and `custom`), and make the text consistent with the support matrix
described elsewhere (for example, the dedicated support list used in
getting-started). Use the existing `app deploy --framework` and `app build
--build-type` references to keep the wording accurate and unambiguous.
---
Nitpick comments:
In `@apps/docs/content/docs/compute/limitations.mdx`:
- Around line 20-25: Clarify the wording in the limitations copy so “production
branch” and “default branch” are not treated as separate concepts, since the
text already says the production branch is the default branch. Update the
relevant sentences in the documentation content to use one consistent term or
explicitly say “production/default branch” where needed, and keep the behavior
notes for app deploy, app promote, branch list, and branch deletion aligned with
that single definition.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: b861884c-7cb1-4cbd-92fb-e71bfea6409b
📒 Files selected for processing (7)
apps/docs/content/docs/compute/branching.mdxapps/docs/content/docs/compute/cli-reference.mdxapps/docs/content/docs/compute/deployments.mdxapps/docs/content/docs/compute/environment-variables.mdxapps/docs/content/docs/compute/faq.mdxapps/docs/content/docs/compute/getting-started.mdxapps/docs/content/docs/compute/limitations.mdx
ellotheth
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
Docs audit driven by real user + agent deployment feedback (a Glitch-style Elysia app port that went sideways). Every behavioral claim below was verified today against a live Compute app with
@prisma/cli@latest; nothing is inferred from old docs.Verified behaviors that contradicted the docs
app deploy --prodfrom a non-default Git branch silently creates a preview deployment.--prodconfirms production, it doesn't select it; branch resolution (--branch→ active Git branch →main) decides the environment, and the CLI doesn't warn. The JSON output even reports"promoted": true(live-within-branch), which reads like a production promotion.app promoteis same-branch only. From a preview Git branch it no-ops with the warningThe selected deployment is already live for this app; from the production branch a preview deployment id fails withDEPLOYMENT_NOT_FOUND. Preview→production promotion is impossible; the old text implied otherwise. It also has no--branchflag (nor doesapp remove) — branch context is Git-only.--frameworkacceptsnextjs, nuxt, astro, hono, nestjs, tanstack-start, custom, bun;app build --build-typeacceptsauto, bun, nextjs, nuxt, astro, nestjs, tanstack-start, custom(checked against CLI validation errors). "First-class support" wording removed — an agent extrapolated it into claiming Elysia has first-class support. The docs now state the dedicated list is exhaustive and that everything else (Elysia, Express, Fastify, …) deploys as a plain Bun server with no framework-specific handling.Page-by-page
--prod; promote section rewritten with same-branch semantics, the two failure modes, the correct path to production, and what to do when promote "does nothing"; new troubleshooting section "The deploy succeeded but the app only serves an error page" (bind0.0.0.0, listen onprocess.env.PORT, runtime-read files must ship in the artifact, repro withapp build/app run) — none of this was documented anywhere.--prod+ branch resolution.--prodandapp promotelimitations; corrected framework/build-type lists; stated the generic-Bun-server path explicitly.--prodfrom a non-default branch still gets preview vars, and how to check viabranch.kind.app deploy --prod. Why did I get a preview deployment?" and "Why didapp promotedo nothing?".--prodbranch-context note.How it was tested
Content-only MDX change. CLI behavior verified against a live project: deployed
--prodfrom a throwaway non-default branch (got"kind": "preview"), exercised promote from both branch contexts (observed the no-op warning andDEPLOYMENT_NOT_FOUND), extracted flag enums from CLI validation errors, and cleaned the test branch up afterwards.Follow-ups / known limitations
--prodis passed but the resolved branch is a preview?app promoteof a valid production deployment also returned a transientDEPLOY_FAILED(Internal Server Error) that succeeded on retry — and the rebuilt old deployment served 404s until rollback, which is worth a look.prisma-computeagent skill should get the same corrections so agents stop overclaiming framework support.Linear: DR-8720
🤖 Generated with Claude Code
Summary by CodeRabbit
--proddoes.