Skip to content

docs(compute): coding-assistant previews, environments page title, FAQ entry - #8454

Merged
gregory-boch-prisma merged 2 commits into
mainfrom
docs/compute-coding-assistant-previews
Oct 12, 2026
Merged

gregory-boch-prisma merged 2 commits into
mainfrom
docs/compute-coding-assistant-previews

Conversation

@gregory-boch-prisma

@gregory-boch-prisma gregory-boch-prisma commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

These four Prisma Compute docs pages explain how to host a test version of an app, including a feature a coding assistant is building, as a preview or staging environment without replacing production.

Changes

apps/docs/content/docs/compute/deploy-on-push.mdx

  • New section "If a coding assistant is building the feature", between "A long-lived staging environment" and "How it works". The assistant pushes a feature branch, which deploys as a preview with its own services and, for databases declared in the Composer module, its own new database; production data is not copied, and the DATABASE_URL caveat is repeated. It says a push to the default branch deploys production without asking, links GitHub's "About protected branches" page, links agent enrollment (an enrolled agent works on preview branches and asks before changing production through the Prisma API), and says that policy does not cover the deploy workflow. It ends with the preview URL in the deploy report, merge, and teardown.
  • First paragraph: one added sentence that links the new section.
  • description and metaDescription name a coding assistant.
  • Next steps: the link text for /compute/branching now uses that page's new title.
  • metaTitle: not changed. metaDescription: changed. First paragraph: changed (one sentence appended). First table: the page has none.

apps/docs/content/docs/compute/branching.mdx (URL kept)

  • title: "Environments: production, staging and preview branches"; metaTitle: the same plus " | Prisma Compute".
  • New section "Preview vs staging environments" after "Production and preview": a Preview / Staging / Production table (Git branch, what a push does, database, variables, URL, teardown), the DATABASE_URL caveat, and one sentence on npx prisma deploy module.ts --stage staging without GitHub.
  • metaTitle: changed. metaDescription: not changed. First paragraph: not changed. First table: new (the page had none).

apps/docs/content/docs/compute/faq.mdx

apps/docs/content/docs/(index)/prisma-compute/agent-enrollment.mdx (its own commit)

These docs pages have no Updated field or update history, so no date line was added.

Sources checked 2026-10-12

Checks run locally

  • pnpm --filter docs test: 76 of 76 pass.
  • pnpm --filter docs lint:links: 0 errors.
  • cspell on the four files: 0 issues. check-ai-signs.sh on the four files: clean.
  • pnpm --filter docs build, then start on port 3001: all four pages return 200 with the new <title>, meta description and H1, the canonical URLs are the same as before, and each .md URL renders the new sections.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated compute guides to explain production, staging, and preview environments, including their branches, deployments, databases, variables, URLs, and teardown behavior.
    • Added instructions for creating staging environments without a GitHub connection and clarified that database separation depends on DATABASE_URL.
    • Expanded guidance on coding-assistant workflows, including preview deployments, protecting the default branch, reviewing changes before merging, and agent credentials and approval requirements.
    • Updated related page titles, descriptions, links, and FAQs.

gregory-boch-prisma and others added 2 commits October 12, 2026 10:50
…itle, FAQ entry

- deploy-on-push: "If a coding assistant is building the feature" section
  (feature branch, default-branch protection, enrolled agent credential,
  preview URL from the deploy report), description and meta description
  mention a coding assistant, Next steps link uses the new page title.
- branching: title and meta title become "Environments: production, staging
  and preview branches"; new "Preview vs staging environments" table.
- faq: "Can my coding assistant deploy a test version without touching
  production?" entry; "What's a branch?" links the Environments docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ault policy

Frontmatter only: title and meta title. The body is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
blog Ready Ready Preview Oct 12, 2026 8:53am UTC
docs Ready Ready Preview Oct 12, 2026 8:53am UTC
eclipse Ready Ready Preview Oct 12, 2026 8:53am UTC
site Ready Ready Preview Oct 12, 2026 8:53am UTC
1 Skipped Deployment
Project Deployment Actions Updated
handbook Skipped Skipped Oct 12, 2026 8:53am UTC

Request Review

@vercel
vercel Bot temporarily deployed to Preview – handbook October 12, 2026 08:51 Inactive
@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: a828acd9-ec28-4e87-9625-23162cd29721

📥 Commits

Reviewing files that changed from the base of the PR and between 273a70b and 38e3861.


📒 Files selected for processing (4)
  • apps/docs/content/docs/(index)/prisma-compute/agent-enrollment.mdx
  • apps/docs/content/docs/compute/branching.mdx
  • apps/docs/content/docs/compute/deploy-on-push.mdx
  • apps/docs/content/docs/compute/faq.mdx

Included review availability: This review used your included allowance. Your plan provides up to 5 included reviews per hour; 0 remain after this review.



Walkthrough

The docs now describe preview, staging, and production environments and explain how coding assistants use preview branches. They also document database behavior, default-branch deployment, branch protection, and enrolled agents’ Prisma credentials.

Changes

Compute environment documentation

Layer / File(s) Summary
Environment definitions and links
apps/docs/content/docs/compute/branching.mdx, apps/docs/content/docs/compute/faq.mdx, apps/docs/content/docs/compute/deploy-on-push.mdx
The docs compare preview, staging, and production environments, including branch selection, push behavior, databases, variables, URLs, and teardown. Related links now point to the Environments guide.
Coding-agent preview and production guidance
apps/docs/content/docs/(index)/prisma-compute/agent-enrollment.mdx, apps/docs/content/docs/compute/deploy-on-push.mdx, apps/docs/content/docs/compute/faq.mdx
The docs explain coding-agent preview deployments, preview database behavior, default-branch deployment, branch protection, and enrolled agents’ Prisma credentials and production approval requirements.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: sorenbs, ankur-arch

Merge Risk: ⚪ Minimal · up to 38e38

No actionable documentation issue is established in the supplied review context. The author reports that the documentation checks passed, so the mergeability risk is minimal.

Pre-merge checks | Passed 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 summarizes the main documentation changes: coding-assistant previews, the environments page, and the FAQ entry.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

161 links: ✅ 66 OK | 🚫 0 errors | 🔀 18 redirects | 👻 95 excluded

✅ All links are working!


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

@gregory-boch-prisma

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@gregory-boch-prisma

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@gregory-boch-prisma
gregory-boch-prisma merged commit 99a0810 into main Oct 12, 2026
26 of 27 checks passed
@gregory-boch-prisma
gregory-boch-prisma deleted the docs/compute-coding-assistant-previews branch October 12, 2026 13:19

This branch was successfully deployed

4 active and 1 inactive deployments
Preview – docs — 38e3861b Deployed Oct 12, 2026 by vercel[bot]
Preview – blog — 38e3861b Deployed Oct 12, 2026 by vercel[bot]
Preview – site — 38e3861b Deployed Oct 12, 2026 by vercel[bot]
Preview – eclipse — 38e3861b Deployed Oct 12, 2026 by vercel[bot]
Preview – handbook — 38e3861b Deployed Oct 12, 2026 by vercel[bot]
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