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.
  • 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, your changes merge to the deployment branch and deploy immediately when you publish.
Branch typeBranch protectionPublishing workflow
NoneCommits and deploys changes
Deployment branchPull requests requiredCreates a pull request
NoneMerges changes to deployment branch and deploys changes
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.
When you work on your deployment branch, changes automatically save.
Web editor toolbar showing one pending change.
When you work on a feature branch, save changes to the branch.
Web editor toolbar showing one pending change and the Save in branch button on a feature branch.
To discard changes, click Undo changes beside a filename in the files changed dropdown.

​
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. If there are no pending changes or a pull request for the current branch is already open, the Publish button is unclickable.
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.

​
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 try to merge branches with incompatible changes to the same files.
  • You and another team member edit the same lines in a file on different branches.
  • You move, rename, or delete files on one branch and modify them differently on another branch.

​
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.