Skip to content

docs(compute): prisma.compute.ts configuration reference + Nuxt/Astro framework lists#7950

Merged
AmanVarshney01 merged 7 commits into
mainfrom
aman/compute-config-docs
Jun 16, 2026
Merged

docs(compute): prisma.compute.ts configuration reference + Nuxt/Astro framework lists#7950
AmanVarshney01 merged 7 commits into
mainfrom
aman/compute-config-docs

Conversation

@AmanVarshney01

@AmanVarshney01 AmanVarshney01 commented Jun 16, 2026

Copy link
Copy Markdown
Member

What

  1. New Configuration reference page for the prisma.compute.ts file (shipped in feat: typed prisma.compute.ts compute config prisma-cli#84), slotted into the Compute section nav under Reference, before cli-reference. Covers:

    • when to use a config vs. zero-config deploy; the minimal single-app shape and defineComputeConfig
    • every app field (name, root, framework, entry, httpPort, env, build) as a table
    • env shapes and the committed-file secrets caveat
    • build settings incl. the nuxt/astro "no build block" rule
    • file discovery (nearest config up to repo root; config dir = project dir)
    • monorepos: the apps map, deploy-all vs. targeting one app, build/run needing a target
    • how config defaults interact with flags
  2. Framework-list consistency. Nuxt and Astro deploy support is live, but the quickstart, getting-started, cli-reference --framework, and limitations still listed only nextjs/hono/tanstack-start/bun (while --build-type already listed nuxt/astro). Updated all of them to the full set: nextjs, nuxt, astro, hono, tanstack-start, bun.

Verification

lint:links and lint:code pass; cross-link anchors resolve; formatted with oxfmt.

Summary by CodeRabbit

  • Documentation
    • Added a new Compute configuration guide for prisma.compute.ts (and JS/MTS variants), covering supported fields, env handling, build behavior, and monorepo discovery rules.
    • Expanded documented framework support to include Nuxt and Astro across setup and CLI references.
    • Updated Prisma Compute CLI documentation, including framework detection, agent skills installation via npx, and refreshed branch-related commands.
    • Refined Compute limitations and branching behavior guidance for the beta.

New Reference page documenting the typed config file: the single-app and
monorepo (apps) shapes, every app field (name/root/framework/entry/httpPort/
env/build), env shapes, build settings (incl. the nuxt/astro caveat), file
discovery, monorepo deploy-all/target selection, and how config defaults
interact with flags. Linked into the compute section nav before cli-reference.
@vercel

vercel Bot commented Jun 16, 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, Comment Jun 16, 2026 1:23pm
docs Ready Ready Preview, Comment Jun 16, 2026 1:23pm
eclipse Ready Ready Preview, Comment Jun 16, 2026 1:23pm
site Ready Ready Preview, Comment Jun 16, 2026 1:23pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 16, 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7d3aa0d2-3be1-4ecd-baf0-d4856851f7a2

📥 Commits

Reviewing files that changed from the base of the PR and between 481a0f0 and 073ad42.

📒 Files selected for processing (2)
  • apps/docs/content/docs/compute/cli-reference.mdx
  • apps/docs/content/docs/compute/getting-started.mdx
✅ Files skipped from review due to trivial changes (1)
  • apps/docs/content/docs/compute/getting-started.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/docs/compute/cli-reference.mdx

Walkthrough

Adds a new configuration.mdx reference page documenting prisma.compute.ts and registers it in the Compute nav. Across existing Compute docs, expands the supported framework lists to include Nuxt and Astro, renames branch show to branch list, adds database to documented CLI command groups, and replaces the agent skills installation instructions with npx skills add prisma/skills --skill prisma-compute.

Changes

Prisma Compute Documentation Updates

Layer / File(s) Summary
New configuration.mdx page and nav registration
apps/docs/content/docs/compute/meta.json, apps/docs/content/docs/compute/configuration.mdx
Registers "configuration" in the Compute nav pages list and creates the full 197-line prisma.compute.ts reference covering app fields, env/build settings, config discovery, monorepo apps targeting, and CLI flag precedence.
Framework list expansions, branch command rename, and CLI command group updates
apps/docs/content/docs/(index)/prisma-compute/deploy.mdx, apps/docs/content/docs/compute/getting-started.mdx, apps/docs/content/docs/compute/cli-reference.mdx, apps/docs/content/docs/compute/branching.mdx, apps/docs/content/docs/compute/limitations.mdx
Adds nuxt and astro to supported framework lists across all affected pages. Renames branch show to branch list in branching.mdx and cli-reference.mdx; removes branch show and branch use from the CLI reference table. Adds database to documented CLI command groups in cli-reference.mdx and limitations.mdx.
Agent skills installation update
apps/docs/content/docs/compute/cli-reference.mdx, apps/docs/content/docs/compute/getting-started.mdx
Replaces the prior pnpm dlx ... --all bulk installation with npx skills add prisma/skills --skill prisma-compute, removes CLI version pinning and the enumerated prisma-cli* skill list, and updates the "install all skills" guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • prisma/web#7931: Directly edits the same Compute docs files (branching.mdx, cli-reference.mdx, prisma-compute/deploy.mdx) that this PR further updates with CLI command renames, framework additions, and agent skill guidance changes.
🚥 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 describes the two main contributions: adding prisma.compute.ts configuration documentation and updating framework lists (Nuxt/Astro) across Compute docs.
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.

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


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

@github-actions

github-actions Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

52 links: ✅ 2 OK | 🚫 0 errors | 🔀 2 redirects | 👻 48 excluded

✅ All links are working!


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

Nuxt and Astro deploy support is live, but several pages still enumerated
only nextjs/hono/tanstack-start/bun for --framework and in prose (while
--build-type already listed nuxt/astro). Bring the deploy quickstart,
getting-started, cli-reference --framework, and limitations in line so the
full set is consistent: nextjs, nuxt, astro, hono, tanstack-start, bun.
@AmanVarshney01 AmanVarshney01 changed the title docs(compute): add prisma.compute.ts configuration reference docs(compute): prisma.compute.ts configuration reference + Nuxt/Astro framework lists Jun 16, 2026
@argos-ci

argos-ci Bot commented Jun 16, 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 - Jun 16, 2026, 1:30 PM

app build is not a dev server, so 'a dev server can only run one app'
mis-justified the build case. State the real reason: build and run have
no all-apps form, unlike deploy.
Skills moved to the prisma/skills repo (skills at the root). Update the
install commands to npx skills add prisma/skills --skill prisma-compute,
which is the Compute deploy skill (the prisma-cli skill is now the ORM CLI
reference). Drop the obsolete #cli-v<version> pin — prisma/skills is not
versioned by CLI tag.
Restructure with commas, colons, parentheses, and separate sentences
instead.
Audited every documented CLI invocation against prisma-cli:
- Remove branch show and branch use; the CLI only has branch list.
- Stop claiming there is no database command. It exists (database
  list/show/create/connection), so add it to the command groups and drop
  it from the 'no X command' list. (No full reference section yet.)

All other commands, flags, build types, error codes, and env vars already
matched.

@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/getting-started.mdx`:
- Around line 176-178: Change the code fence delimiters from bash to npm for
package manager install commands to enable auto-tabbed rendering across
different package managers. In
apps/docs/content/docs/compute/getting-started.mdx at lines 176-178, change the
fence from `bash` to `npm` for the `npx skills add prisma/skills --skill
prisma-compute` command. In apps/docs/content/docs/compute/cli-reference.mdx at
lines 174-176, apply the same change from `bash` to `npm` fence for the
identical install command. This allows the documentation tooling to
automatically generate tabs for alternative package managers (bun, yarn, pnpm)
alongside the default npm rendering.
🪄 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: 9d364926-bf41-46cb-8565-e10dca9bca24

📥 Commits

Reviewing files that changed from the base of the PR and between 7163b7d and 481a0f0.

📒 Files selected for processing (7)
  • apps/docs/content/docs/(index)/prisma-compute/deploy.mdx
  • apps/docs/content/docs/compute/branching.mdx
  • apps/docs/content/docs/compute/cli-reference.mdx
  • apps/docs/content/docs/compute/configuration.mdx
  • apps/docs/content/docs/compute/getting-started.mdx
  • apps/docs/content/docs/compute/limitations.mdx
  • apps/docs/content/docs/compute/meta.json

Comment thread apps/docs/content/docs/compute/getting-started.mdx Outdated
So the docs tooling auto-generates the package-manager tabs (bun/yarn/pnpm)
for the skills install command, per the apps/docs convention.
Comment thread apps/docs/content/docs/compute/configuration.mdx
@AmanVarshney01 AmanVarshney01 merged commit 84e9729 into main Jun 16, 2026
17 checks passed
@AmanVarshney01 AmanVarshney01 deleted the aman/compute-config-docs branch June 16, 2026 13:49
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.

2 participants