Skip to content

Update branch creation and switching docs #5385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
+26 −6
Closed

Update branch creation and switching docs #5385

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 26 additions & 6 deletions guides/branches.mdx
View file
Open in desktop
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,15 @@

<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 pending changes, choose whether to bring them to the new branch or leave them on the current branch.
1. Click **Create branch**.

<Tip>
You can also type a branch name in the search field and press **Enter** to create a branch with that name if no matching branch exists.
</Tip>
</Tab>
<Tab title="Using local development">
<Steps>
Expand Down Expand Up @@ -96,11 +101,26 @@

<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 switcher.
1. Use the search field to filter branches by name.
1. Select the branch you want to switch to.

The branch switcher organizes branches into two sections:

- **Synced in editor**: Branches that are ready to use in the editor.
- **Not synced in editor**: Branches that exist in your repository but haven't been synced to the editor yet. Selecting one of these branches starts a sync.

Each branch displays a status badge to help you identify its state:

| Badge | Meaning |
|-------|---------|
| **Default** | Your deployment branch |
| **Current** | The branch you are working on |
| **Syncing** | The branch is syncing to the editor |
| **Failed** | The branch failed to sync |

<Warning>
Unsaved changes are lost when switching branches. Save your work first.
Unsaved changes are lost when switching branches. Save your work first, or create a new branch and bring your changes with you.
</Warning>
</Tab>
<Tab title="Using local development">
Expand Down
Loading