Skip to content

docs: document selective publishing in the editor #7329

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document selective publishing in the editor #7329

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
12 changes: 12 additions & 0 deletions editor/publish.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@

If there are no pending changes, the editor disables the publish and save actions.

## Publish selected changes

By default, publishing includes every pending change on the branch. To publish only some of them, open the publish menu and select the changes you want to include. The editor publishes only the selected changes and keeps the rest as pending.

Select up to 500 changes per publish. This applies to both **Publish** and **Create pull request**.

Some pending changes depend on other pending changes to keep the navigation consistent. For example, a new page added to a new group can't publish without the group. When you select a change that depends on another, the editor automatically includes the changes it needs. If a dependency can't be resolved, the editor drops the selection instead of publishing an inconsistent navigation.

Check warning on line 32 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L32 

In general, use active voice instead of passive voice ('be resolved').

<Note>
Selective publishing is available on request. Contact Mintlify to enable it for your deployment.
</Note>

## What happens when you publish

| Branch type | Branch protection | Available actions |
Expand Down Expand Up @@ -50,7 +62,7 @@
To create a branch, click the branch name in the editor toolbar, select **Create new branch**, enter a name, then click **Create branch**.

<Note>
Creating a branch while you have unpublished changes prompts you to bring those changes with you or leave them behind. Changes you leave behind stay on the original branch. Switching to an existing branch doesn't prompt you, and unsaved changes are lost. Save your work before switching. See [Work with branches](/guides/branches).

Check warning on line 65 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L65 

In general, use active voice instead of passive voice ('are lost').
</Note>

### Show the branch selector
Expand All @@ -73,6 +85,6 @@

## Auto publish

If your deployment has auto publish (called [Main branch autocommits](/editor/settings#main-branch-autocommits) in the editor settings) turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and **Publish** button are hidden. There is no pending state and no review step.

Check warning on line 88 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L88 

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

Edits on feature branches created from the editor commit automatically either way, but they never publish unless you merge them into your deployment branch.