docs(docs): clarify Compute custom domain setup#8023
Conversation
Linear: DR-8710 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation for custom domains now requires targeting the production branch when running domain-related CLI commands. A warning is added explaining that ChangesDomains documentation update
Estimated code review effort: 1 (Trivial) | ~4 minutes Related PRs: None identified. Suggested labels: documentation Suggested reviewers: None identified.
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
🍈 Lychee Link Check Report2 links: ✅ All links are working!Full Statistics Table
|
|
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}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
apps/docs/content/docs/compute/domains.mdx (1)
19-34: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueSlightly repetitive branch-requirement explanation.
The production-branch requirement is explained three times in close proximity (line 19's general rule, line 21's preview-only deploy note, and line 33's
--branchexplanation), each with a different error string. Not incorrect, but readers may find the overlap a bit redundant. Consider consolidating into a single clear explanation if you revisit this section.🤖 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/domains.mdx` around lines 19 - 34, Consolidate the repeated production-branch guidance in the domain commands section so it explains the requirement once instead of three times. Update the prose around the domain add example and the surrounding explanation in domains.mdx to merge the general rule, the preview-only deploy note, and the --branch clarification into a single concise paragraph while keeping the key behavior and error condition clear.
🤖 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.
Nitpick comments:
In `@apps/docs/content/docs/compute/domains.mdx`:
- Around line 19-34: Consolidate the repeated production-branch guidance in the
domain commands section so it explains the requirement once instead of three
times. Update the prose around the domain add example and the surrounding
explanation in domains.mdx to merge the general rule, the preview-only deploy
note, and the --branch clarification into a single concise paragraph while
keeping the key behavior and error condition clear.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 47b2e635-4e25-4985-9e06-c0b4f5083378
📒 Files selected for processing (1)
apps/docs/content/docs/compute/domains.mdx
1 participant
What changed and why
Follow-up from setting up
typescript-berlin.prisma.ioon Compute — three gaps in /compute/domains caused avoidable friction:app domain addfail withSelected app does not exist in the resolved project(not the documentedBRANCH_NOT_DEPLOYABLE). Added a note and theapp deploy --prodcommand to Before you start.--branch mainto every domain command example plus one sentence explaining why.switchboard.fra.prisma.buildvalue, TTL), a note that some providers want the FQDN, and where the record lives in--jsonoutput.How it was tested
Content-only MDX change. Every command and error message was reproduced against a real Compute app today (CLI
@prisma/cli@latest); the CNAME example mirrors the actualdnsRecordsoutput.Follow-ups / known limitations
domain addis meant to resolve against the production branch regardless of local state, that's a CLI fix and the--branchguidance here can be simplified afterwards.Linear: DR-8710
🤖 Generated with Claude Code
Summary by CodeRabbit