Skip to content

Add documentation for branch management rules#134

Merged
PavelLaptev merged 2 commits intomainfrom
rules-page
Dec 12, 2025
Merged

Add documentation for branch management rules#134
PavelLaptev merged 2 commits intomainfrom
rules-page

Conversation

@PavelLaptev
Copy link
Contributor

This pull request adds comprehensive documentation for the new "Rules" automation feature in branch management, making it easier for users to understand and leverage automatic change assignment in GitButler. It also updates the branch management documentation index to include the new rules documentation.

Documentation for Rules automation:

  • Added a new file, rules.mdx, that explains how to use rules to automatically assign file changes to specific branches based on file patterns, content, or AI session IDs. The documentation covers rule creation, filter types, rule evaluation logic, best practices, and limitations, with illustrative videos and examples.

Documentation navigation update:

  • Updated the branch management documentation index in meta.json to include the new "rules" page, ensuring it appears in the navigation.

Added a new 'rules.mdx' page describing the rules feature for automating change assignment in branch management. Updated 'meta.json' to include the new rules documentation in the navigation.
@vercel
Copy link
Contributor

vercel bot commented Dec 12, 2025

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

Project Deployment Preview Comments Updated (UTC)
gitbutler-docs Ready Ready Preview Comment Dec 12, 2025 1:34am

@github-actions
Copy link

Broken Link Checker

21 broken links found. Links organised below by source page, or page where they were found.

1) /guide

Target Link Link Text Reason
https://app.gitbutler.com/downloads "downloading" HTTP_500

2) /cli-guides/cli-tutorial/branching-and-commiting

Target Link Link Text Reason
https://www.notion.so/Rubbing-2545a4bfdeac80209d37cd4d629316cc?pvs=21 "Rubbing" HTTP_404

3) /features/branch-management/rules

Target Link Link Text Reason
/docs/features/branch-management/virtual-branches "Virtual Branches" HTTP_404
/docs/features/branch-management/branch-lanes "Branch Lanes" HTTP_404
/docs/features/branch-management/ai-assistance "AI Assistance" HTTP_404

4) /features/branch-management/moving-branches

Target Link Link Text Reason
/docs/features/branch-management/stacked-branches "Stacked Branches" HTTP_404
/docs/features/branch-management/branch-lanes "Branch Lanes" HTTP_404
/docs/features/branch-management/virtual-branches "Virtual Branches" HTTP_404

5) /commands/but-push

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-push%22 "Give us feedback" HTTP_429

6) /commands/but-publish

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-publish%22 "Give us feedback" HTTP_429

7) /commands/but-forge

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-forge%22 "Give us feedback" HTTP_429

8) /commands/but-oplog

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-oplog%22 "Give us feedback" HTTP_429

9) /commands/but-undo

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-undo%22 "Give us feedback" HTTP_429

10) /commands/but-restore

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-restore%22 "Give us feedback" HTTP_429

11) /commands/but-snapshot

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22commands/but-snapshot%22 "Give us feedback" HTTP_429

12) /community/open-source

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22community/open-source%22 "Give us feedback" HTTP_429

13) /features/ai-integration/cursor-hooks

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22features/ai-integration/cursor-hooks%22 "Give us feedback" HTTP_429

14) /features/forge-integration/gitlab-integration

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22features/forge-integration/gitlab-integration%22 "Give us feedback" HTTP_429

15) /features/ai-integration/ai-overview

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22features/ai-integration/ai-overview%22 "Give us feedback" HTTP_429

16) /features/ai-integration/mcp-server

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22features/ai-integration/mcp-server%22 "Give us feedback" HTTP_429

17) /features/ai-integration/claude-code-hooks

Target Link Link Text Reason
https://github.com/gitbutlerapp/gitbutler-docs/issues/new?label=docs&title=Feedback+for+page+%22features/ai-integration/claude-code-hooks%22 "Give us feedback" HTTP_429

Copy link
Contributor

@aspleenic aspleenic left a comment

Choose a reason for hiding this comment

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

Under "To create a rule:", step 3, bullet one - should be "Specify a branch by name"

Also, "kebab menu"? Usually see this referred to as a "ham
burger menu"

Corrected wording for branch selection instructions and replaced 'kebab menu' with 'elepsis menu' in the steps for editing and deleting rules.
Copy link
Contributor

@aspleenic aspleenic left a comment

Choose a reason for hiding this comment

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

lgtm

@PavelLaptev PavelLaptev merged commit 6e16fec into main Dec 12, 2025
3 checks passed
@PavelLaptev PavelLaptev deleted the rules-page branch December 12, 2025 12:39
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.

2 participants