Document pull request-backed editor branches - #7009
Open
cdxker wants to merge 1 commit into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
2 participants
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.
Description
Updates the editor branch guide for the new pull request-backed workflow.
Test Plan
npx mint@latest validateNote
Low Risk
Documentation-only change to a single MDX guide with no product or security impact.
Overview
Rewrites Branching and publishing for the editor’s pull request-backed workflow instead of the older publish/save matrix tied to branch protection.
Autosave and Git: Feature-branch edits now autosave to Mintlify and Git and refresh the draft PR and preview without clicking Publish. The deployment branch still needs Publish (or main branch autocommits) to reach Git and production.
Branches: Creating a branch opens a draft pull request automatically; the doc adds visibility rules (only deployment branch and PR-backed branches in the selector) and keeps the bring-or-leave pending changes step when branching.
Removed or slimmed: The branch-type vs protection action table, separate “when to use a branch” guidance, the note about unpublished changes when switching branches, and simultaneous publishing per branch.
Review flow: PR titles/descriptions are created at draft open (editable in the branch menu or Git host), not only at publish; previews are tied to editor saves on branches rather than manual “save to feature branch.”
Reviewed by Cursor Bugbot for commit 5852d1c. Bugbot is set up for automated code reviews on this repo. Configure here.