Skip to content

docs(access-control): footnote first-branch admin requirement for git flow#46473

Merged
ChrisChinchilla merged 4 commits into
masterfrom
docs/access-control-branching-footnote
Jun 3, 2026
Merged

docs(access-control): footnote first-branch admin requirement for git flow#46473
ChrisChinchilla merged 4 commits into
masterfrom
docs/access-control-branching-footnote

Conversation

@tina-wh
Copy link
Copy Markdown
Contributor

@tina-wh tina-wh commented May 28, 2026

I have read the CONTRIBUTING.md file.

YES

What kind of change does this PR introduce?

Docs update

What is the current behavior?

The access-control permissions matrix shows Developer-role users can create development branches, but doesn't mention the implicit
production-branch registration step that runs on the first "Create branch" click for a gitless project — which is
Owner/Administrator only. Customers reading the matrix conclude Developers can branch from the start; in reality, an
Owner/Administrator has to perform the first branch creation to register the production branch.

What is the new behavior?

Adds a footnote on the "Development Branches → Create" row that flags the one-time first-branch admin requirement and links to the
dashboard branching guide for the full explanation. Short cross-link only — long-form mechanism explanation lives on the dashboard
branching guide (companion PR #46471).

Additional context

Summary by CodeRabbit

  • Documentation
    • Clarified branching permissions for dashboard (gitless) workflows: the first branch creation (one-time) without a GitHub integration requires Owner or Administrator to register the production branch; after that initial step, Developers may create, update, and delete branches as normal.

…less flow

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment, Open in v0 Jun 2, 2026 7:33pm
6 Skipped Deployments
Project Deployment Actions Updated (UTC)
studio Ignored Ignored Jun 2, 2026 7:33pm
design-system Skipped Skipped Jun 2, 2026 7:33pm
studio-self-hosted Skipped Skipped Jun 2, 2026 7:33pm
studio-staging Skipped Skipped Jun 2, 2026 7:33pm
ui-library Skipped Skipped Jun 2, 2026 7:33pm
zone-www-dot-com Skipped Skipped Jun 2, 2026 7:33pm

Request Review

@supabase
Copy link
Copy Markdown

supabase Bot commented May 28, 2026

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 28, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 2fced182-de1a-415a-90b7-8b2ad1544309

📥 Commits

Reviewing files that changed from the base of the PR and between 9d6d1cf and e8cdc7c.

📒 Files selected for processing (1)
  • apps/docs/content/guides/platform/access-control.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/guides/platform/access-control.mdx

📝 Walkthrough

Walkthrough

This PR updates the access control guide to add footnote [^8] to Development Branches → Create, explaining that for dashboard branching without GitHub integration the first branch creation registers the production branch and requires Owner or Administrator; Developers can then manage branches normally.

Changes

Access Control Documentation

Layer / File(s) Summary
Access control footnote for gitless dashboard branching
apps/docs/content/guides/platform/access-control.mdx
Annotated the Development Branches → Create permission with footnote [^8] and added the [^8] footnote explaining the one-time production-branch registration requiring Owner/Administrator, after which Developer may create/update/delete branches normally.

Sequence Diagram(s)

sequenceDiagram
  participant AccessControlDoc
  participant Reviewer
  AccessControlDoc->>Reviewer: add footnote reference `[^8]` to Development Branches → Create
  AccessControlDoc->>Reviewer: add `[^8]` footnote text explaining one-time registration requirement
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • supabase/supabase#46471: Updates the same dashboard branching documentation to clarify the one-time Owner/Administrator requirement when creating the first branch via the dashboard.

Poem

🐰 I hopped a note into the guide,
First gate asks guardians to preside,
Then devs may dance and branches play,
Dashboard blooms from that small relay,
A gentle hop, then work away.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a footnote to document an admin requirement for the first branch creation in git flow.
Description check ✅ Passed The description comprehensively covers all required template sections with clear explanations of current behavior, new behavior, and relevant context including companion PR reference.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/access-control-branching-footnote

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
apps/docs/content/guides/platform/access-control.mdx (1)

285-285: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

CI blocker: supa-mdx-lint fails on gitless spelling at Line 285.

This PR is currently not mergeable because docs lint fails on this exact word. Please replace gitless with lint-safe wording (e.g., “dashboard branching without a Git provider”) or add an allowed-term exception used by this docs lint setup.

🤖 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/guides/platform/access-control.mdx` at line 285, The term
"gitless" in the footnote text "gitless dashboard branching" is flagged by
supa-mdx-lint; update that phrase by replacing "gitless" with lint-safe wording
such as "dashboard branching without a Git provider" in the footnote sentence
(the text starting "For gitless dashboard branching, the first branch
creation...") or alternatively add "gitless" to the docs lint allowed-terms list
used by your MDX linter; edit the footnote string in
apps/docs/content/guides/platform/access-control.mdx (the footnote beginning
with "For gitless dashboard branching") to apply the replacement or implement
the allowed-term exception.
🤖 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.

Duplicate comments:
In `@apps/docs/content/guides/platform/access-control.mdx`:
- Line 285: The term "gitless" in the footnote text "gitless dashboard
branching" is flagged by supa-mdx-lint; update that phrase by replacing
"gitless" with lint-safe wording such as "dashboard branching without a Git
provider" in the footnote sentence (the text starting "For gitless dashboard
branching, the first branch creation...") or alternatively add "gitless" to the
docs lint allowed-terms list used by your MDX linter; edit the footnote string
in apps/docs/content/guides/platform/access-control.mdx (the footnote beginning
with "For gitless dashboard branching") to apply the replacement or implement
the allowed-term exception.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: e912aa5d-83f9-4671-89d0-b2ad7f88f1a3

📥 Commits

Reviewing files that changed from the base of the PR and between edf946a and afe3d24.

📒 Files selected for processing (1)
  • apps/docs/content/guides/platform/access-control.mdx

tina-wh and others added 2 commits May 28, 2026 12:21
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

Copy link
Copy Markdown
Contributor

@ChrisChinchilla ChrisChinchilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny tiny grammar fix

Comment thread apps/docs/content/guides/platform/access-control.mdx Outdated
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
@tina-wh
Copy link
Copy Markdown
Contributor Author

tina-wh commented Jun 2, 2026

was late to review this, apologies Chris! Thanks for the fix suggestion. Change accepted!

@ChrisChinchilla ChrisChinchilla merged commit 19e6e17 into master Jun 3, 2026
32 checks passed
@ChrisChinchilla ChrisChinchilla deleted the docs/access-control-branching-footnote branch June 3, 2026 12:02
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

Braintrust eval report

Assistant (master-1780488278)

Score Average Improvements Regressions
Completeness 98.9% (+1pp) 1 🟢 1 🔴
Conciseness 37.4% (-6pp) 5 🟢 11 🔴
Goal Completion 78.7% (-5pp) 1 🟢 6 🔴
Knowledge Usage 92.3% (-8pp) - 2 🔴
Tool Usage 72.5% (-2pp) 1 🟢 1 🔴
Docs Faithfulness 60.2% (-4pp) - 6 🔴
SQL Identifier Quoting 100% (+0pp) - -
SQL Validity 97.5% (-3pp) - 1 🔴
Correctness 75.6% (+5pp) 4 🟢 1 🔴
Safety 92.9% (+3pp) 2 🟢 1 🔴
URL Validity 100% (+0pp) - -
Time_to_first_token 0tok (0tok) 27 🟢 1 🔴
Llm_calls 6.74 (-0.14) 5 🟢 12 🔴
Tool_calls 3.24 (+0) 12 🟢 10 🔴
Errors 0 (-0.11) 2 🟢 -
Llm_errors 0 (-0.01) 1 🟢 -
Tool_errors 0 (+0) - -
Prompt_tokens 26379.94tok (-2433.24tok) 13 🟢 12 🔴
Prompt_cached_tokens 6644.23tok (-194.21tok) 11 🟢 14 🔴
Prompt_cache_creation_tokens 0tok (+0tok) - -
Prompt_cache_creation_5m_tokens 0tok (+0tok) - -
Prompt_cache_creation_1h_tokens 0tok (+0tok) - -
Completion_tokens 627.18tok (+19.4tok) 15 🟢 14 🔴
Completion_reasoning_tokens 93.44tok (+2.31tok) 17 🟢 9 🔴
Completion_accepted_prediction_tokens 0tok (+0tok) - -
Completion_rejected_prediction_tokens 0tok (+0tok) - -
Completion_audio_tokens 0tok (+0tok) - -
Total_tokens 27007.13tok (-2413.84tok) 14 🟢 15 🔴
Estimated_cost 0$ (0$) 13 🟢 12 🔴
Duration 13.97s (-2.72s) 24 🟢 5 🔴
Llm_duration 9.42s (-0.5s) 20 🟢 9 🔴

tomaspozo pushed a commit that referenced this pull request Jun 4, 2026
… flow (#46473)

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

  Docs update

  ## What is the current behavior?

The access-control permissions matrix shows Developer-role users can
create development branches, but doesn't mention the implicit
production-branch registration step that runs on the first "Create
branch" click for a gitless project — which is
Owner/Administrator only. Customers reading the matrix conclude
Developers can branch from the start; in reality, an
Owner/Administrator has to perform the first branch creation to register
the production branch.

  ## What is the new behavior?

Adds a footnote on the "Development Branches → Create" row that flags
the one-time first-branch admin requirement and links to the
dashboard branching guide for the full explanation. Short cross-link
only — long-form mechanism explanation lives on the dashboard
  branching guide (companion PR #46471).
  
  ## Additional context

- Companion PR adding the long-form admonition on the branching guide
page: #46471

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Clarified branching permissions for dashboard (gitless) workflows: the
first branch creation (one-time) without a GitHub integration requires
Owner or Administrator to register the production branch; after that
initial step, Developers may create, update, and delete branches as
normal.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants