Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion editor/git-essentials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ These are the Git concepts you'll encounter most often when using the web editor

Your live documentation builds from a **deployment branch**, usually called `main`. Other branches let you work on changes independently. Nothing on a branch affects your live site until you merge it into your deployment branch with a pull request.

When you create a branch, the web editor creates a new branch in your repository. You can switch between branches from the branch dropdown in the toolbar.
When you create a branch, the web editor creates a new branch in your repository. You can search for and switch between branches from the branch dropdown in the toolbar. If you have unsaved changes, the editor lets you bring them to the new branch or leave them on your current branch.
</Accordion>
<Accordion title="Deployment branch">
The branch that builds your live documentation site, typically called `main`. Changes merged into this branch automatically deploy to your site.
Expand Down
14 changes: 9 additions & 5 deletions guides/branches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Branches let you create separate instances of your documentation to make changes, get reviews, and try new approaches before publishing. Your team can work on branches to update different parts of your documentation simultaneously without affecting what users see on your live site.

The following diagram shows an example of a branch workflow where a feature branch is created, changes are made, and then the feature branch is merged into the main branch.

Check warning on line 11 in guides/branches.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/branches.mdx#L11

In general, use active voice instead of passive voice ('is created').

Check warning on line 11 in guides/branches.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/branches.mdx#L11

In general, use active voice instead of passive voice ('are made').

Check warning on line 11 in guides/branches.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/branches.mdx#L11

In general, use active voice instead of passive voice ('is merged').

```mermaid
gitGraph
Expand Down Expand Up @@ -50,10 +50,11 @@

<Tabs>
<Tab title="Using web editor">
1. Click the branch name in the editor.
1. Click **New Branch**.
1. Click the branch name in the editor toolbar.
1. Click **Create new branch**.
1. Enter a descriptive name.
1. Click **Create Branch**.
1. If you have unsaved changes, choose whether to bring them to the new branch or leave them on your current branch.
1. Click **Create branch**.
</Tab>
<Tab title="Using local development">
<Steps>
Expand Down Expand Up @@ -96,8 +97,11 @@

<Tabs>
<Tab title="Using web editor">
1. Select the branch name in the editor toolbar.
1. Select the branch you want to switch to from the dropdown menu.
1. Click the branch name in the editor toolbar to open the branch dropdown.
1. Search for a branch by name or scroll through the list.
1. Click the branch you want to switch to.

Each branch in the dropdown displays a status indicator so you can see whether it is ready, syncing, or failed.

<Warning>
Unsaved changes are lost when switching branches. Save your work first.
Expand Down
Loading