mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
693dbc361f
* Fix Vale style warnings across docs from past week of merges Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
64 lines
3.7 KiB
Plaintext
64 lines
3.7 KiB
Plaintext
---
|
|
title: "How to use the editor"
|
|
description: "Step-by-step walkthrough of the Mintlify editor: create a branch, edit pages, share a preview deployment for review, and publish your documentation changes."
|
|
keywords: ["editor", "tutorial", "branch", "publish"]
|
|
---
|
|
|
|
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.
|
|
|
|
<Steps>
|
|
<Step title="Create a branch">
|
|
A branch is a temporary copy of your content. It's where you make your changes without affecting your live site.
|
|
|
|
Think of branches like drafts. You can merge them into your live site or safely discard them 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`).
|
|
<Frame>
|
|
<img src="/images/editor/create-branch-light.png" alt="Branch name emphasized in the editor toolbar." className="block dark:hidden" />
|
|
<img src="/images/editor/create-branch-dark.png" alt="Branch name emphasized in the editor toolbar." className="hidden dark:block" />
|
|
</Frame>
|
|
1. Click **Create new branch**.
|
|
1. Enter a name that describes your change, like `update-quickstart`.
|
|
1. Click **Create branch**.
|
|
|
|
The editor switches to your new branch. Any changes you make are only on the branch. They only appear on your live site when you complete the publishing process.
|
|
</Step>
|
|
<Step title="Make your changes">
|
|
Edit an existing page or create a new one.
|
|
|
|
**To edit a page**: Click it in the navigation sidebar to open it. Type directly in the editor to add content. Press <kbd>/</kbd> to insert components, images, or other content.
|
|
|
|
**To create a page**: Click the <Icon icon="plus" /> plus button next to the navigation group where you want to add the page, then click **Add a page** and enter a filename.
|
|
|
|
<Frame>
|
|
<img src="/images/editor/add-page-light.png" alt="The add page menu opened beside a group in the editor." className="block dark:hidden" />
|
|
<img src="/images/editor/add-page-dark.png" alt="The add page menu opened beside a group in the editor." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
</Step>
|
|
<Step title="Publish your branch">
|
|
To review your changes, you must create a pull request. A pull request is a proposal to merge your changes into the main branch that builds your site.
|
|
|
|
When you publish your branch, you make it available for review by your team. The changes only appear on your live site if you merge the pull request.
|
|
|
|
1. Click **Publish** in the toolbar to open the publish menu.
|
|
<Frame>
|
|
<img src="/images/editor/publish-menu-light.png" alt="The publish menu opened in the editor toolbar." className="block dark:hidden" />
|
|
<img src="/images/editor/publish-menu-dark.png" alt="The publish menu opened in the editor toolbar." className="hidden dark:block" />
|
|
</Frame>
|
|
1. Optionally, click any changed file in the list to view and compare your edits against the published version.
|
|
1. Click **Save in branch** to save all changes on your branch.
|
|
1. Click **Create pull request**. Add a title and description, then click **Publish pull request**.
|
|
1. Continue to GitHub to view your pull request and review your changes.
|
|
|
|
</Step>
|
|
<Step title="Review your changes">
|
|
Share your pull request with your team to review your changes.
|
|
</Step>
|
|
<Step title="Merge your pull request">
|
|
After your team approves your changes, merge your pull request into the main branch. Your changes deploy to your live site.
|
|
</Step>
|
|
</Steps>
|