From ed72509722b55c14ebe90c3e6355a9367eb3aeca Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 01:51:12 +0000 Subject: [PATCH] docs: update publish page with new branch and merge workflows Generated-By: mintlify-agent --- editor/publish.mdx | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/editor/publish.mdx b/editor/publish.mdx index d32caed34..338635c03 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -9,20 +9,20 @@ keywords: ["editor", "publish", "changes", "branches", "pull requests"] The editor supports two workflows for publishing documentation updates. The workflow you use depends on your repository's branch protection rules and the branch you work on. -**Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. +**Publish directly**: If your repository has no branch protection rules on your deployment branch, your changes commit and deploy immediately when you click **Publish**. + +**Create pull requests**: If your repository has branch protection rules that require pull requests, the editor guides you through a branch-based workflow. You can create a new branch for your changes, open a pull request, track its review status, and merge it — all from the editor. When you create a pull request from the editor, the Mintlify agent generates a title and description based on your changes. You can edit the generated title and description before creating the pull request. -**Publish directly**: If your repository has no branch protection rules, your changes merge to the deployment branch and deploy immediately when you publish. - | Branch type | Branch protection | Publishing workflow | |-------------|-------------------|------------------------------| | Deployment branch | None | Commits and deploys changes | -| Deployment branch | Pull requests required | Creates a pull request | -| Feature branch | None | Merges changes to deployment branch and deploys changes | -| Feature branch | Pull requests required | Creates a pull request | +| Deployment branch | Pull requests required | Creates a new branch for your changes | +| Feature branch | None | Saves changes to branch, with option to create a pull request | +| Feature branch | Pull requests required | Saves changes to branch | Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub docs or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab docs. @@ -56,14 +56,29 @@ To discard changes, click **Undo changes** beside a filename in the files change ## Publish your changes -Click **Publish** in the toolbar. Depending on your workflow, your changes deploy immediately or create a pull request for you to merge in your Git provider. If you are on a feature branch, save your changes before publishing. +Click **Publish** in the toolbar to open the publish menu, then select the action for your workflow: -If there are no pending changes or a pull request for the current branch is already open, the **Publish** button is unclickable. +- **Publish**: Commits your changes directly to the deployment branch. Available when you are on the deployment branch with no branch protections. +- **Save in branch**: Commits your changes to the current feature branch. Available when you are on a feature branch. +- **Create branch**: Moves your changes to a new branch. Available when you are on a protected deployment branch. +- **Create pull request**: Opens a pull request from your feature branch to the deployment branch. Available on feature branches without branch protections when no pull request is already open. + +If there are no pending changes, the action button is disabled. Your live documentation site updates after Mintlify builds and deploys your published changes. This typically takes 30 seconds to a few minutes. Check the deployment status of your changes on your [dashboard](https://dashboard.mintlify.com). +## Review and merge pull requests + +When a pull request is open for your current branch, the publish menu shows its review status: + +- **Approved**: The pull request has been approved by reviewers. +- **Changes requested**: Reviewers have requested changes. +- **Awaiting review**: The pull request is waiting for review. + +Click **View request** to open the pull request in your Git provider. If the pull request is approved and your branch has no remaining protections, click **Merge and publish** to merge the pull request and deploy your changes directly from the editor. + ## Resolve conflicts Conflicts occur when your branch and the deployment branch have incompatible changes to the same files.