docs: add App Preview API key guide#898
Conversation
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_40a3753c-519b-460f-9a71-cf090be8847d) |
📝 WalkthroughWalkthroughThe documentation defines the App Preview RBAC role, updates API key scoping and setup instructions, and clarifies preview channel and owned bundle deletion behavior. ChangesApp Preview RBAC guidance
Estimated code review effort: 2 (Simple) | ~15 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
4e6cb7d to
a44ba35
Compare
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_b1b0555f-aceb-4375-b074-312da402bccc) |
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/src/content/docs/docs/webapp/api-keys.mdx`:
- Line 50: Update the App Developer role description in the API keys
documentation to remove the claim that it can manage app configuration; describe
only deployment and channel-settings access, or explicitly distinguish those
permissions from app settings, consistent with the organization roles
documentation.
- Around line 41-43: Update the organization-creation guidance in the API key
documentation to state that org.create requires an org-scoped org_admin or
org_super_admin binding, explicitly mapping the dashboard’s “Admin” role to the
appropriate binding when applicable. Preserve the existing permission and
automatic Super Admin assignment details.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: e4438429-294f-4d2e-b4d0-e673d9c10e17
📒 Files selected for processing (6)
.github/pr-assets/app-preview-api-key-docs.webpapps/docs/src/content/docs/docs/cli/reference/channel.mdxapps/docs/src/content/docs/docs/public-api/api-keys.mdxapps/docs/src/content/docs/docs/webapp/api-keys.mdxapps/docs/src/content/docs/docs/webapp/channels.mdxapps/docs/src/content/docs/docs/webapp/organization-roles.mdx
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
Cap-go/capacitor-updater(manual)
a44ba35 to
a4e19cd
Compare
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_a8882765-92a9-4769-b87c-40006285962a) |
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver External
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_94d598e4-6d5d-46f5-a74e-3eb20ee4010e) |
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver External
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_4f07dceb-51f9-4422-b54c-fd9f4b3590c8) |
There was a problem hiding this comment.
Stale comment
Risk: low. Cursor Bugbot did not complete successfully (skipped due to usage limit), so automated review is unavailable for this run. Leaving a non-blocking comment; human reviewers are already assigned for this documentation-only PR.
Sent by Cursor Approval Agent: Pull Request Approver
There was a problem hiding this comment.
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/src/content/docs/docs/cli/reference/channel.mdx`:
- Around line 59-65: Remove or clearly mark the unsupported --delete-bundle App
Preview cleanup flow in
apps/docs/src/content/docs/docs/cli/reference/channel.mdx lines 59-65,
apps/docs/src/content/docs/docs/webapp/organization-roles.mdx line 117,
apps/docs/src/content/docs/docs/public-api/api-keys.mdx lines 53 and 126,
apps/docs/src/content/docs/docs/webapp/api-keys.mdx lines 65-91, and
apps/docs/src/content/docs/docs/webapp/channels.mdx line 91; do not present it
as available until the companion implementation is released.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 952480ab-8661-4249-9e3f-035b2656badc
📒 Files selected for processing (7)
.github/pr-assets/app-preview-api-key-docs.webp.github/pr-assets/app-preview-api-key-public-api-docs.webpapps/docs/src/content/docs/docs/cli/reference/channel.mdxapps/docs/src/content/docs/docs/public-api/api-keys.mdxapps/docs/src/content/docs/docs/webapp/api-keys.mdxapps/docs/src/content/docs/docs/webapp/channels.mdxapps/docs/src/content/docs/docs/webapp/organization-roles.mdx
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
Cap-go/capacitor-updater(manual)
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_4d92fcd5-b2fe-4e63-8246-4601ef5e27c9) |
|





Summary
app_previewgrant and the automatic, channel-scopedchannel_previewgrant created only when the key creates a channel.channel delete --delete-bundlecleanup flow, with an explicit availability gate until the companion release is deployed.app_previewretains app-level read access, so the feature provides lifecycle/write isolation rather than strict channel-read isolation.Dependency
Documents the companion implementation in Cap-go/capgo.app#2698. The special preview cleanup is explicitly marked unavailable until that implementation is released.
Validation
bunx prettier --writeon the touched documentation filesbun run ci:verify:docs/docs/webapp/api-keys/Visual diff
Generated with
bun run visual-diff:compare(2 screenshots, fuzz 1%).