Skip to content
Closed
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/collaborate.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Collaborate in the editor"
sidebarTitle: "Collaborate"
description: "Leave comments, propose changes as suggestions, and edit alongside teammates in real time in the editor."
description: "Comment on pages, propose changes as suggestions, resolve feedback, and edit alongside your teammates in real time in the Mintlify editor."
keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"]
---

Expand Down
2 changes: 1 addition & 1 deletion editor/publish.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Publish changes"
sidebarTitle: "Publish"
description: "Publish changes from the editor to your live site. Branches and protection rules determine what happens when you publish."
description: "Publish changes from the web editor to your live documentation site. Learn how branches and protection rules determine what happens when you publish."
keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull request"]
---

Expand Down Expand Up @@ -67,6 +67,6 @@

## Auto publish

If your deployment has [auto publish](/editor/settings#main-branch-autocommits) 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 70 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L70

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.
2 changes: 1 addition & 1 deletion editor/review.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Review changes"
sidebarTitle: "Review"
description: "Preview changes before they go live, share them with your team, and approve and merge pull requests from the editor."
description: "Preview documentation changes before they go live, share them with your team, and approve and merge pull requests directly from the web editor."
keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"]
---

Expand Down Expand Up @@ -68,7 +68,7 @@

### Pull request titles and descriptions

If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor generates one listing the files you created, updated, moved, or deleted. To control how those are written, set [PR instructions](/editor/settings#pr-instructions).

Check warning on line 71 in editor/review.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/review.mdx#L71

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

If your branch has open comment threads, Mintlify adds a summary of them to the pull request description. See [Collaborate](/editor/collaborate#comments).

Expand Down
2 changes: 1 addition & 1 deletion migration/manual.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Migrate from another platform"
description: "Convert documentation from any source platform to Mintlify pages, navigation, components, API references, assets, and redirects."
description: "Convert documentation from any source platform to Mintlify, including pages, navigation, components, API references, assets, and redirects."
keywords: ["manual documentation migration", "Markdown migration", "MDX migration", "docs.json"]
---

Expand Down Expand Up @@ -48,7 +48,7 @@
| Translated documentation | Languages |
| Group overview | A group with a `root` page |

Add every page path to `docs.json` unless you intend to hide the page. A [hidden page](/organize/hidden-pages) remains reachable by URL, but it is excluded from site search, sitemaps, search engine indexing, and AI context by default.

Check warning on line 51 in migration/manual.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration/manual.mdx#L51

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

## Convert your content

Expand Down Expand Up @@ -87,7 +87,7 @@

Copy images, videos, fonts, and downloadable files that you own into your repository. Preserve existing public paths where practical to reduce link changes.

Review the following patterns to identify assets that need to be migrated.

Check warning on line 90 in migration/manual.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration/manual.mdx#L90

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

- Markdown image and link destinations
- HTML `<img>` and `<video>` elements
Expand Down