Skip to content

docs: document automerge setup banner and squash merge requirement#5821

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
docs/workflow-automerge-banner
Open

docs: document automerge setup banner and squash merge requirement#5821
mintlify[bot] wants to merge 2 commits into
mainfrom
docs/workflow-automerge-banner

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 15, 2026

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

  • Added a Troubleshoot automerge section to the Configure automerge guide that explains when the dashboard banner appears and lists the three reasons it can surface (squash merging disabled, missing Mintlify bypass on branch rules, previously unaccepted automerge run).
  • Added squash merging enabled to the prerequisites, since it is now required for automerge.
  • Mirrored the updates to the Spanish, French, and Chinese translations.

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-automerge guide 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 15, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 15, 2026, 4:48 PM

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.

0 participants