Skip to main content

​
Publishing workflows

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. If your repository has branch protection rules requiring review, the editor creates a pull request. Team members can review your changes before they go live. For collaboration workflows and team review processes, see Collaborate. If there are no protection rules, your changes merge to the deployment branch and deploy immediately.
Branch typeBranch protectionWhat happens when you publish
NoneCommits and deploys changes
Deployment branchPull requests requiredCreates a pull request
NoneMerges changes to deployment branch and deploys
Feature branchPull requests requiredCreates a pull request
Configure branch protection rules in your Git provider to require pull requests. See About protected branches in the GitHub docs or Protected branches in the GitLab docs.

​
Save changes

As you edit, the editor tracks your changes.
  • New or deleted files.
  • Content edits in pages.
  • Navigation structure changes.
  • Media uploads and organization.
  • Configuration updates.
Web editor toolbar showing one pending change.
When you work on your deployment branch, changes are saved automatically. When you work on a feature branch, you can save changes to the branch as .
Web editor toolbar showing one pending change and the Save as commit button on a feature branch.
To discard changes, click Undo changes beside a file name in the Changes dropdown.

​
Publish your changes

If you are on your deployment branch, click Publish in the toolbar. Depending on your workflow, your changes are live as soon as your site redeploys or create a pull request and merge it in your Git provider. If you are on a feature branch, save your changes and then click Publish in the toolbar. Depending on your workflow, your changes are live as soon as your site redeploys or create a pull request and merge it in your Git provider.

​
Resolve conflicts

Conflicts occur when your branch and the deployment branch have incompatible changes to the same files.

​
What causes conflicts

Conflicts happen when:
  • You and another team member edit the same lines in a file.
  • Files are moved or deleted in one branch but modified in another.

​
Resolve conflicts

The editor displays warnings when conflicts prevent operations like publishing or switching branches. To resolve conflicts, follow the instructions in the editor to choose which changes to keep.

​
Commit signing

Sign commits with your GitHub account by authorizing it in your account settings. Without authorization, the Mintlify GitHub App signs commits made in the web editor. Attributing commits to your account maintains an accurate history of who made changes to your documentation.