Skip to content
Open
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 ai/contextual-menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: ["AI tools", "ChatGPT", "Claude", "Perplexity", "MCP", "Grok", "cursor
import { PreviewButton } from "/snippets/previewbutton.jsx"
import IconsRequired from "/snippets/icons-required.mdx";

The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users select the contextual menu on any page, they can copy content as context for AI tools or open conversations in ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Windsurf, or a custom tool of your choice with your documentation already loaded as context.
The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users select the contextual menu on any page, they can copy content as context for AI tools or open it in an AI conversation. Supported tools include ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Windsurf, and any custom tool you configure.

<Tip>
Pair the contextual menu with your hosted [`skill.md`](/ai/skillmd) file and [MCP server](/ai/model-context-protocol) so that users can install your product's full capabilities into their AI tools, not just the page they are reading.
Expand Down
4 changes: 2 additions & 2 deletions ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
The MCP search tool supports optional parameters that AI applications use to control and refine search results.

- **`pageSize`**: Number of results to return, between 1 and 50. Defaults to 10.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Only returns results at or above this threshold. Use this to filter out low-relevance matches.

Check warning on line 51 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L51

Use 'preceding' instead of 'above'.
- **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions.
- **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages.

Expand Down Expand Up @@ -97,7 +97,7 @@
<Steps>
<Step title="Enable authenticated MCP in your dashboard">
1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
2. Click the **Enable MCP Server** toggle.
2. Select the **Enable MCP Server** toggle.
</Step>
<Step title="Add redirect domains">
Add the redirect domains for the AI tools you want to grant your users access to. Your users' AI tools cannot complete authentication unless their redirect domain is on this list. Common redirect domains include `claude.ai` and `vscode.dev/redirect`.
Expand Down Expand Up @@ -399,7 +399,7 @@

<PreviewButton href="cursor://anysphere.cursor-deeplink/mcp/install?name=mintlify&config=eyJ1cmwiOiJodHRwczovL21pbnRsaWZ5LmNvbS9kb2NzL21jcCJ9">Install in Cursor</PreviewButton>

To connect the Mintlify MCP server to Cursor, click the **Install in Cursor** button. Or to manually connect the MCP server, follow these steps:
To connect the Mintlify MCP server to Cursor, select the **Install in Cursor** button. Or to manually connect the MCP server, follow these steps:

<Steps>
<Step title="Open MCP settings">
Expand Down
2 changes: 1 addition & 1 deletion api-playground/managing-page-visibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["x-hidden", "x-excluded", "hide endpoints", "page visibility", "internal endpoints"]
---

For internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation, you can control which OpenAPI operations get published as documentation pages and their visibility in navigation.
You can control which OpenAPI operations get published as documentation pages and their visibility in navigation. This is useful for internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation.

If your pages are autogenerated from an OpenAPI document, manage page visibility with the `x-hidden` and `x-excluded` extensions.

Expand All @@ -14,9 +14,9 @@

Common use cases for `x-hidden` are:

- Endpoints you want to document, but not promote.

Check warning on line 17 in api-playground/managing-page-visibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/managing-page-visibility.mdx#L17

Use 'endpoints?' instead of 'Endpoints'.
- Pages that you link to from other content.
- Endpoints for specific users.

Check warning on line 19 in api-playground/managing-page-visibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/managing-page-visibility.mdx#L19

Use 'endpoints?' instead of 'Endpoints'.

## `x-excluded`

Expand Down
4 changes: 2 additions & 2 deletions assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ https://yourdocs.mintlify.app/quickstart?assistant=How%20do%20I%20get%20started%

## Highlight text

Highlight text on a page and click the **Add to assistant** pop up button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context.
Highlight text on a page and select the **Add to assistant** button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context.

<Frame>
<img src="/images/assistant/highlight-light.png" alt="The Add to assistant button above highlighted text in light mode." className="block dark:hidden" />
Expand All @@ -90,7 +90,7 @@ Highlight text on a page and click the **Add to assistant** pop up button to ope

## Code blocks

Click the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context.
Select the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context.

<Frame>
<img src="/images/assistant/code-block-light.png" alt="The Ask AI button in a code block in light mode." className="block dark:hidden" />
Expand Down
2 changes: 1 addition & 1 deletion dashboard/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ keywords: ["editor access", "permissions", "team", "seats", "deployment"]

People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically.

Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard.
Anyone with access to your documentation repository can contribute by pushing changes. However, their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard.
10 changes: 5 additions & 5 deletions deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## Create preview deployments

Preview deployments are created automatically through pull requests or manually from your dashboard.

Check warning on line 17 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L17

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

### Automatic previews

Expand Down Expand Up @@ -43,12 +43,12 @@

You can also create preview deployments programmatically using the [Trigger preview deployment](/api/preview/trigger) API endpoint. This is useful for integrating preview creation into CI/CD pipelines or custom tooling.

## Redeploy a preview

Check warning on line 46 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L46

Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.

Redeploy a preview to refresh content or retry after a failed deployment.

Check warning on line 48 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L48

Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.

1. Select the preview from your [dashboard](https://dashboard.mintlify.com/).
2. Select **Redeploy**.

Check warning on line 51 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L51

Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.

<Frame>
<img src="/images/previews/redeploy-preview-light.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="block dark:hidden" />
Expand All @@ -64,10 +64,10 @@
<img src="/images/previews/widget-dark.png" alt="Preview widget expanded to show list of changed files." className="hidden dark:block" />
</Frame>

1. Click the widget to show all added, modified, or removed files in the preview.
1. Click a file to view the changes on the corresponding page.
1. Select the widget to show all added, modified, or removed files in the preview.
1. Select a file to view the changes on the corresponding page.
1. Use the search bar to filter the list of changed files.
1. Hover over a file and click the **Open in editor** icon to edit the file directly in the web editor.
1. Hover over a file and select the **Open in editor** icon to edit the file directly in the web editor.

The widget only appears on preview deployments, not on your live site or local previews.

Expand All @@ -80,7 +80,7 @@
Restrict preview access to authenticated members of your Mintlify organization.

1. Navigate to the **Previews** section in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
2. Click the **Preview authentication** toggle to enable or disable preview authentication.
2. Select the **Preview authentication** toggle to enable or disable preview authentication.
<Frame>
<img src="/images/previews/preview-auth-light.png" alt="The preview authentication toggle in the Add-ons page" className="block dark:hidden" />
<img src="/images/previews/preview-auth-dark.png" alt="The preview authentication toggle in the Add-ons page" className="hidden dark:block" />
Expand Down Expand Up @@ -109,7 +109,7 @@

If your preview deployment fails, try these troubleshooting steps.

- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures.
- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and select the failed preview. The deployment logs show errors that caused failures.
- **Check your configuration**:
- Invalid `docs.json` syntax
- Missing or incorrect file paths referenced in your navigation
Expand Down
2 changes: 1 addition & 1 deletion deploy/vercel.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Vercel"
description: "Configure Vercel rewrites to serve your Mintlify documentation at a subpath on your main domain with step-by-step vercel.json setup."

Check warning on line 3 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"]
---

Expand All @@ -8,7 +8,7 @@

Configure your `vercel.json` file to proxy requests from your main domain to your documentation at a subpath.

## vercel.json file

Check warning on line 11 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L11

'vercel.json file' should use sentence-style capitalization.

Check warning on line 11 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L11

Use 'JSON' instead of 'json'.

The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings.

Expand All @@ -21,14 +21,14 @@
### Host at `/docs` subpath

1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard.
2. Click the **Host at `/docs`** toggle to the on position.
2. Set the **Host at `/docs`** toggle to on.
<Frame>
<img alt="Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle." src="/images/subpath/toggle-light.png" className="block dark:hidden" />
<img alt="Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle." src="/images/subpath/toggle-dark.png" className="hidden dark:block" />
</Frame>
3. Enter your domain.
4. Select **Add domain**.
5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which is found at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`.

Check warning on line 31 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L31

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

```json
{
Expand All @@ -55,7 +55,7 @@

### Host at custom subpath

To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory.

Check warning on line 58 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L58

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

Use the generator below to create your rewrites configuration. Add the rewrites to your `vercel.json` file.

Expand Down
26 changes: 13 additions & 13 deletions editor/branching-and-publishing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
keywords: ["editor", "branch", "publish", "pull request", "preview", "git", "merge", "deploy"]
---

The web editor autosaves everything as you type, but your changes are only live when you choose to publish them.

Check warning on line 7 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L7

Did you really mean 'autosaves'?

What happens when you publish depends on two things: **which branch you're on** and **whether that branch requires pull requests**.

## Saving versus publishing

**Saving** happens automatically. Your edits are stored on Mintlify's servers and persist across browser tabs, devices, and network interruptions.

Check warning on line 13 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L13

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

**Publishing** commits your changes to your Git repository. Click the **Publish** button in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request.
**Publishing** commits your changes to your Git repository. Select **Publish** in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request.

The editor tracks the following as pending changes:

Expand All @@ -24,7 +24,7 @@

## What happens when you publish

The actions available when you click the publish button depend on your current branch and whether it has branch protection rules that require pull requests.
The actions available when you select the publish button depend on your current branch and whether it has branch protection rules that require pull requests.

| Branch type | Branch protection | Available actions |
|-------------|-------------------|-------------------|
Expand All @@ -38,7 +38,7 @@
- **Create branch**: Moves your pending changes to a new feature branch when you're on a protected deployment branch.
- **Create pull request**: Opens a pull request targeting your deployment branch.

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

Check warning on line 41 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L41

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

<Note>
Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your [dashboard](https://dashboard.mintlify.com).
Expand All @@ -48,33 +48,33 @@

**Edit directly on your deployment branch** if you do not use a Git-based workflow.

**Create a branch** when you use a docs-as-code workflow where each change to your content is made on a separate branch.

Check warning on line 51 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L51

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

## Create and switch branches

### Create a branch

1. Click the branch name in the editor toolbar.
1. Click **Create new branch**.
1. Select the branch name in the editor toolbar.
1. Select **Create new branch**.
1. If you have pending changes, choose whether to bring them to the new branch or leave them on the current branch.
1. Enter a name and click **Create branch**.
1. Enter a name and select **Create branch**.

<Tip>
Use descriptive branch names so you can easily identify them and other people understand what each branch is for.
</Tip>

### Switch branches

1. Click the branch name in the toolbar.
1. Select the branch name in the toolbar.
1. Search for or scroll to the branch you want.
1. Click the branch to switch to it.
1. Select the branch to switch to it.

<Note>
Switching branches while you have unpublished changes will prompt you to bring those changes to the new branch or leave them behind. Changes left behind remain on your original branch.

Check warning on line 73 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L73

Avoid using 'will'.
</Note>

<Tip>
To copy a branch name, hover over the branch in the dropdown and click the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request.
To copy a branch name, hover over the branch in the dropdown and select the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request.
</Tip>

## Preview your changes
Expand All @@ -83,8 +83,8 @@

### Access and share a preview

1. Click **Publish** in the editor toolbar.
1. In the publish menu, click the preview URL. The URL format is `organization-branch-name.mintlify.app`.
1. Select **Publish** in the editor toolbar.
1. In the publish menu, select the preview URL. The URL format is `organization-branch-name.mintlify.app`.
<Frame>
<img src="/images/editor/preview-url-light.png" alt="Preview URL emphasized in the publish menu." className="block dark:hidden" />
<img src="/images/editor/preview-url-dark.png" alt="Preview URL emphasized in the publish menu." className="hidden dark:block" />
Expand Down Expand Up @@ -112,21 +112,21 @@

When a pull request is open for the current branch, the publish menu shows its review status:

- **Approved**: The pull request has been approved and is ready to merge.

Check warning on line 115 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L115

In general, use active voice instead of passive voice ('been approved').
- **Changes requested**: A reviewer has requested changes before the pull request can merge.
- **Awaiting review**: The pull request is waiting for a reviewer.

Click **View request** to open the pull request in your Git provider.
Select **View request** to open the pull request in your Git provider.

When the pull request is approved, click **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging.
When the pull request is approved, select **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging.

Check warning on line 121 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L121

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

<Tip>
Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub docs or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab docs.
</Tip>

### Review changes before merging

Click any changed file in the publish menu to open it in diff view and compare your branch against the published version. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable.
Select any changed file in the publish menu to open it in diff view and compare your branch against the published version. Files that can't display a diff, such as images or deleted files, appear in the list but aren't selectable.

### Simultaneous publishing

Expand All @@ -144,13 +144,13 @@

## Collaborate in real time

When multiple people open the same page on the same branch, they edit together in real time. Each person's cursor and edits are visible to everyone, with avatars shown in the toolbar.

Check warning on line 147 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L147

Use 'Cursor' instead of 'cursor'.

- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts.
- Undo only affects your own edits.
- If you lose your connection, edits save locally and sync when you reconnect.

When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears in the editor like any other collaborator. You see the agent's avatar in the toolbar and a live cursor at its most recent edit location. The cursor clears automatically after the agent finishes.

Check warning on line 153 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L153

Use 'Cursor' instead of 'cursor'.

Check warning on line 153 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L153

Use 'Cursor' instead of 'cursor'.

## Git sync

Expand Down
2 changes: 1 addition & 1 deletion editor/live-preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Preview your site while you edit. Live previews render pages exactly as they loo

## Open live preview

Click the <Icon icon="play" /> live preview button in the toolbar to open a live preview in a new tab.
Select the <Icon icon="play" /> live preview button in the toolbar to open a live preview in a new tab.

<Frame>
<img
Expand Down
6 changes: 3 additions & 3 deletions editor/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

## Add navigation elements

Click **Add new** at the bottom of the navigation tree to add a new element at the root level. To add an element nested inside another, click the <Icon icon="plus" /> plus button next to that element.
Select **Add new** at the bottom of the navigation tree to add a new element at the root level. To add an element nested inside another, select the <Icon icon="plus" /> plus button next to that element.

After creating an element, drag and drop it to reorder or nest it. Hover over an element and click the gear icon to configure its properties.
After creating an element, drag and drop it to reorder or nest it. Hover over an element and select the gear icon to configure its properties.

Check warning on line 13 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L13

Use the Oxford comma in 'After creating an element, drag and'.

Right-click a **page** to open its settings or delete it.

Expand All @@ -24,21 +24,21 @@

Choose the right structure for your content:

- **Pages** — Individual documentation files. The core building block of navigation.

Check warning on line 27 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L27

Don't put a space before or after a dash.
- **Groups** — Collapsible sections that cluster related pages together. Can nest within other groups.

Check warning on line 28 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L28

Don't put a space before or after a dash.
- **Tabs** — Top-level sections with horizontal navigation at the top of your site. Use tabs when you have distinct areas like API Reference and Guides.

Check warning on line 29 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L29

Don't put a space before or after a dash.
- **Anchors** — Persistent items at the top of your sidebar. Useful for quick access to external resources or top-level sections. Can be global to appear on every page.

Check warning on line 30 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L30

Don't put a space before or after a dash.
- **Dropdowns** — Expandable menus at the top of your sidebar. A lighter alternative to tabs for multiple related sections.

Check warning on line 31 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L31

Use 'dropdowns?' instead of 'Dropdowns'.

Check warning on line 31 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L31

Don't put a space before or after a dash.
- **Menus** — Dropdown navigation items within a tab for direct links to specific pages.

Check warning on line 32 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L32

Don't put a space before or after a dash.

Check warning on line 32 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L32

Use 'dropdowns?' instead of 'Dropdown'.
- **Products** — A switcher for multiple distinct product documentation sets, each with its own navigation structure.

Check warning on line 33 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L33

Don't put a space before or after a dash.
- **Versions** — A switcher for multiple simultaneous documentation versions.

Check warning on line 34 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L34

Don't put a space before or after a dash.
- **Languages** — A switcher for documentation in multiple languages.

Check warning on line 35 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L35

Don't put a space before or after a dash.

## Configure elements

Hover over any navigation element and click the gear icon to set:
Hover over any navigation element and select the gear icon to set:

- **Title**: The label shown in the sidebar.
- **Icon**: A visual marker next to the label.
- **Tag**: A badge like "NEW" or "BETA" to highlight the item.

Check warning on line 43 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L43

Spell out 'NEW', if it's unfamiliar to the audience.

Check warning on line 43 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L43

Spell out 'BETA', if it's unfamiliar to the audience.

18 changes: 9 additions & 9 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@

## Navigate files

Browse pages in the **Navigation** tab of the left panel. Click a page to open it. Click the search icon or press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search by filename or page content.
Browse pages in the **Navigation** tab of the left panel. Select a page to open it. Select the search icon or press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search by filename or page content.

<Note>
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. To update a spec file, edit it in your preferred code editor and push the changes to your documentation repository.

Check warning on line 12 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L12

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

## Create new pages

1. Click the <Icon icon="plus" /> plus button in the navigation element where you want to add a page.
1. Click **Add a page**.
1. Select the <Icon icon="plus" /> plus button in the navigation element where you want to add a page.
1. Select **Add a page**.
1. Enter a filename. The editor adds the `.mdx` extension automatically.

## Edit content
Expand All @@ -29,21 +29,21 @@

**Visual mode** shows a real-time preview as you type. Press <kbd>/</kbd> to open the component menu and insert components, images, videos, and other content. You can also drag and drop media files directly onto the page. Other shortcuts:

- **Insert a link**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows), or drag a page from the navigation tree into the editor to create a link with the page title.
- **Insert a link**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows). You can also drag a page from the navigation tree into the editor to create a link with the page title.
- **Insert an emoji**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker.
- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.

Check warning on line 34 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L34

Use 'Cursor' instead of 'cursor'.

**Markdown mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter.

<Note>
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. Edit them in your code editor and push the changes to your repository.

Check warning on line 39 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L39

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

For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).

### Block actions

In visual mode, hover over any block to reveal a drag handle on the left. Click the handle to open a context menu with actions for that block:
In visual mode, hover over any block to reveal a drag handle on the left. Select the handle to open a context menu with actions for that block:

- **Turn into**: Convert the block to a different type—text, headings, blockquote, or list.
- **Duplicate**: Insert a copy of the block immediately after it.
Expand All @@ -56,7 +56,7 @@

### Table of contents

In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section.
In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Select any heading to scroll to that section.

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59

Did you really mean 'minimap'?

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59

Did you really mean 'minimap'?

### Code block options

Expand All @@ -69,26 +69,26 @@

## Review changes before publishing

Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff; if you're in Markdown mode, you see a Markdown diff.
Open the publish menu and select any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff. If you're in Markdown mode, you see a Markdown diff.

Diff view is read-only. Click the <Icon icon="x" /> button next to the mode toggle to return to editing.
Diff view is read-only. Select the <Icon icon="x" /> button next to the mode toggle to return to editing.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74

Use 'diffs?' instead of 'Diff'.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74

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

## Manage pages

- **Move**: Drag and drop pages to reorder them in navigation.
- **Rename**: Right-click a page and select **Rename**.
- **Duplicate**: Right-click a page and select **Duplicate**.
- **Delete**: Right-click a page and select **Delete**. The page is removed from navigation automatically.

Check warning on line 81 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L81

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

### Pages deleted via Git

If a teammate deletes a page through Git while you have it open, the editor enters read-only mode and shows a banner. Your content is preserved so you can copy it before navigating away.

Check warning on line 85 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L85

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

## Configure pages

Hover over a page and click the gear icon, or right-click and select **Settings**, to configure:
Hover over a page and select the gear icon, or right-click and select **Settings**, to configure:

- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL.

Check warning on line 91 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L91

Use 'sidebars?' instead of 'Sidebar'.
- **Description** and **Keywords**: Improve search and SEO.
- **Layout**: Choose from standard, wide, centered, or custom.

Expand All @@ -100,7 +100,7 @@

Type <kbd>/image</kbd> to upload a new image or select an existing one from your repository. Type <kbd>/video</kbd> to upload or select a video.

You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In Markdown mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`.

Check warning on line 103 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L103

Use 'Cursor' instead of 'cursor'.

### Light and dark image variants

Expand Down
Loading
Loading