Skip to content

Rename "Delete branch" to "Close branch" in branches docs#1694

Open
bjornj12 wants to merge 1 commit into
mainfrom
docs-close-branch
Open

Rename "Delete branch" to "Close branch" in branches docs#1694
bjornj12 wants to merge 1 commit into
mainfrom
docs-close-branch

Conversation

@bjornj12
Copy link
Copy Markdown
Contributor

@bjornj12 bjornj12 commented May 4, 2026

Summary

  • Updates the branches quickstart at pages/data-design/branches/index.mdx to reflect that the action is Close branch, not "Delete branch"
  • Adds a short clarification that closing hides the branch from the active list while preserving its history (no hard delete)
  • Renames the section heading and image alt text accordingly

Test plan

  • Visit /docs/data-design/branches and confirm the section reads "Closing a branch" with the updated copy
  • Confirm the screenshot still renders (filename delete-branch.png is unchanged on disk)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated branch management documentation with new guidance on closing branches. Closing a branch hides it from the active list without permanently removing it, while preserving all history—replacing the previous delete branch approach.

Branches are now closed (hidden, history preserved) rather than hard deleted.

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

vercel Bot commented May 4, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 4, 2026 2:39pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a71ffabc-5e78-4338-8e63-cfc4719003b8

📥 Commits

Reviewing files that changed from the base of the PR and between 37be18e and 36393de.

📒 Files selected for processing (1)
  • pages/data-design/branches/index.mdx

📝 Walkthrough

Walkthrough

The documentation is updated to reflect a change in branch management workflow. The "Deleting a branch" section is replaced with a "Closing a branch" section, clarifying that closing hides branches from the active list while preserving history without permanent deletion.

Changes

Documentation: Branch Closure Guidance

Layer / File(s) Summary
Documentation Content
pages/data-design/branches/index.mdx
"Deleting a branch" subsection is replaced with "Closing a branch," explaining that closing hides branches from the active list without permanent deletion and preserves history.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A branch need not fade to the void,
Close it gently, keep it restored!
History lives, no fear of lost lore—
Just hidden away from the active store. ✨

🚥 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 and concisely describes the main change: renaming documentation references from 'Delete branch' to 'Close branch' in the branches documentation.
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-close-branch

Review rate limit: 4/5 reviews remaining, refill in 12 minutes.

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

@logason
Copy link
Copy Markdown
Member

logason commented May 4, 2026

@bjornj12
Copy link
Copy Markdown
Contributor Author

bjornj12 commented May 4, 2026

missing an updated screenshot

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.

3 participants