docs: document automerge setup banner and squash merge requirement#5821
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: document automerge setup banner and squash merge requirement#5821mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The source PR adds a dismissible warning banner to the Workflows page in the Mintlify dashboard. The banner alerts users when their automerge configuration is incomplete and links them to the GitHub setting they need to fix.
Changes
Note
Low Risk
Low risk documentation-only change that updates automerge setup guidance and adds troubleshooting details; no runtime code or behavior changes.
Overview
Updates the
configure-automergeguide to explicitly require squash merging as a prerequisite for automerge.Adds a new Troubleshoot automerge section describing the dashboard Workflows warning banner, the three conditions that trigger it (squash merge disabled, missing ruleset bypass, prior unaccepted run), and that users can jump to GitHub via Set up on GitHub and dismiss the banner after fixing issues. Changes are mirrored across English, Spanish, French, and Chinese guides.
Reviewed by Cursor Bugbot for commit adf33ff. Bugbot is set up for automated code reviews on this repo. Configure here.