Skip to main content
This tutorial walks you through a complete content update using the editor. You’ll create a branch, make a change, share a preview for review, and publish your changes.
You must have the admin or editor role to complete all the steps in this tutorial. Viewers can edit on a branch and leave comments and suggestions, but they can’t publish or request review. See Roles.
1

Create a branch

A branch is a temporary copy of your content. It’s where you make your changes without affecting your live site. You can merge a branch into your live site or safely discard it if you choose not to make the changes.Working on a branch keeps your edits separate from your live site until you’re ready to share the content with your users.
  1. In the editor toolbar, click the branch name (usually main, with a Live badge). If you don’t see it, show the branch selector.
    Branch name emphasized in the editor toolbar.Branch name emphasized in the editor toolbar.
  2. In Find a branch, type a title that describes your change, like Update quickstart.
  3. Click New branch.
The editor switches to your new branch. Any changes you make are only on the branch, and they commit to the branch automatically as you work. They only appear on your live site if you complete the publishing process.To discard a branch instead of publishing, hover over it in the branch menu and click Delete branch. See Delete a branch.
2

Make your changes

Edit an existing page or create a new one.To edit a page: Click the page name in the navigation sidebar to open it. Type directly in the editor to add content. Press / to insert components, images, or other content.To create a page: Click the plus button next to the navigation group where you want to add the page, then click New page. Type a title for the page. The editor names the file after the title.
The add page menu opened beside a group in the editor.The add page menu opened beside a group in the editor.
3

Publish your branch

When you first edit a branch, the editor opens a pull request for it. A pull request is a proposal to merge your changes into the branch that builds your live site. Your changes only go live after the pull request merges.When you’re ready for review, request it from the publish menu.
  1. Click Publish in the toolbar to open the publish menu.
  2. Optionally, click any changed file in the list to view and compare your edits against the published version.
  3. Click Request review.
A preview deployment builds for your pull request: a temporary link where your changes render exactly as they would on your live site. Find the URL in the pull request comment from the Mintlify bot, and share it with your reviewers.
4

Get your pull request approved

Share the pull request with your team. To open it, click View request in the publish menu. Reviewers can open the pull request in GitHub, GitLab, or Bitbucket to leave comments, request changes, or approve it.If a reviewer requests changes, make the edits in the editor on the same branch. Your updates commit to the existing pull request automatically. You don’t need to create a new one.When all required reviewers have approved, the pull request is ready to merge.
5

Merge and publish

With the pull request approved, click Publish in the toolbar to reopen the publish menu. The menu now shows the pull request status and an option to merge.Click Merge and publish. If Mintlify hosts your repository and approvals aren’t required, the button says Publish instead. The editor merges the pull request and switches you back to your deployment branch. Mintlify builds and deploys your changes. Your live site updates in about 30 seconds to a few minutes.