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 ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ Markdown export respects the same authentication rules as the HTML version of ea

## Keyboard shortcut

Press <kbd>Command</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to your clipboard.
Press <kbd>Cmd</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to your clipboard.
2 changes: 1 addition & 1 deletion ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
Install the official Mintlify connector from the [ChatGPT app directory](https://chatgpt.com/apps/mintlify-mcp/asdk_app_6a4d5a687f0881918be3cb8b4b93773d) and complete the OAuth login when prompted. Once installed, ChatGPT can call the Mintlify admin MCP tools during a chat.
</Tab>
<Tab title="Cursor">
1. Open the command palette with <kbd>Command</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> (<kbd>Ctrl</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> on Windows).
1. Open the command palette with <kbd>Cmd</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> (<kbd>Ctrl</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> on Windows).
2. Search for **Open MCP settings** and click **Add custom MCP**.
3. In `mcp.json`, add the admin MCP:

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

This toggle shares the same `agentReviewProcess` setting as the Slack and dashboard agent, so any change here also applies to those flows.

The toggle is disabled in three cases:

Check warning on line 141 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L141

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

- **Your deploy branch requires a pull request.** If branch protection rules or required approvals prevent direct pushes, MCP changes always open a pull request regardless of this setting.
- **Mintlify hosts your deployment.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request.
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 @@ -434,7 +434,7 @@
<Step title="Publish your MCP server URL for your users">
Create a guide for your users that includes your MCP server URL and the steps to connect it to Cursor.

1. Use <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
1. Use <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
2. Search for `Open MCP settings`.
3. Click **Add custom MCP**. This opens the `mcp.json` file.
4. In `mcp.json`, configure your server:
Expand Down Expand Up @@ -555,7 +555,7 @@

<Steps>
<Step title="Open MCP settings">
1. Use <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
1. Use <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
2. Search for `Open MCP settings`.
3. Click **Add custom MCP**. This opens the `mcp.json` file.
</Step>
Expand Down Expand Up @@ -583,7 +583,7 @@

<PreviewButton href="https://vscode.dev/redirect/mcp/install?name=mintlify&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmintlify.com%2Fdocs%2Fmcp%22%7D">Install in VS Code</PreviewButton>

To connect the Mintlify MCP server to VS Code, click the **Install in VS Code** button. Or to manually connect the MCP server, create a `.vscode/mcp.json` file and add:

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L586

Use 'VSCode' instead of 'vscode'.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The assistant appears in two locations: as a button next to the search bar and a

## Keyboard shortcut

Open the assistant chat panel with the keyboard shortcut <kbd>Command</kbd> + <kbd>I</kbd> on macOS and <kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows.
Open the assistant chat panel with the keyboard shortcut <kbd>Cmd</kbd> + <kbd>I</kbd> on macOS and <kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows.

## URL parameters

Expand Down
2 changes: 1 addition & 1 deletion cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Hover over a component or property to see what it does and a link to its page in

## Go to definition

Hold <kbd>CMD</kbd> (macOS) or <kbd>CTRL</kbd> (Windows) and click to navigate to the definition of:
Hold <kbd>Cmd</kbd> (macOS) or <kbd>Ctrl</kbd> (Windows) and click to navigate to the definition of:

- Snippet components.
- Import paths.
Expand Down
2 changes: 1 addition & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Contact Mintlify support for help with your documentation site, in

## Ask our docs

Use the keyboard shortcut <kbd>Command</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation.
Use the keyboard shortcut <kbd>Cmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation.

## Watch video tutorials

Expand Down
2 changes: 1 addition & 1 deletion create/reusable-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Import snippets into pages using either an absolute or relative path.
The name you use to render an imported snippet as a JSX tag must start with an uppercase letter, such as `MySnippet`. MDX treats lowercase tags such as `<mySnippet />` as literal HTML or custom element names rather than references to imported snippets.

<Tip>
Relative imports enable IDE navigation. Press <kbd>CMD</kbd> and click a snippet name in your editor to jump directly to the snippet definition.
Relative imports enable IDE navigation. Press <kbd>Cmd</kbd> and click a snippet name in your editor to jump directly to the snippet definition.
</Tip>

### Import text
Expand Down
2 changes: 1 addition & 1 deletion deploy/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
Click **Create project access token** and copy the token.

<Note>
If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire and must be updated.
If Project Access Tokens are not available, you can use a Personal Access Token instead. Personal Access Tokens expire, so you must update them when they do.
</Note>

<Frame>
Expand All @@ -74,7 +74,7 @@

To modify your GitLab connection settings after the initial setup, go to [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) and update your project ID, access token, branch, or instance URL directly.

## Revalidate Git settings

Check warning on line 77 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L77

Use 'revalidat(e|es|ed|ing|ion)?' instead of 'Revalidate'.

If your deployment shows unexpected behavior, such as missing branch options or stale configuration, you can force Mintlify to refresh your Git source.

Expand Down
2 changes: 1 addition & 1 deletion help-center/configure-oauth-with-auth0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Map Auth0 to Mintlify's OAuth fields

In your Mintlify dashboard, go to [Authentication](https://app.mintlify.com/products/authentication), set site visibility to **Private**, and choose **Custom** → **OAuth**. Fill in the fields with the following Auth0 values. Replace `YOUR_AUTH0_DOMAIN` with your tenant domain.
In your Mintlify dashboard, go to [Authentication](https://app.mintlify.com/products/authentication), set site visibility to **Private**, and select **Custom** → **OAuth**. Fill in the fields with the following Auth0 values. Replace `YOUR_AUTH0_DOMAIN` with your tenant domain.

| Mintlify field | Auth0 value |
|---|---|
Expand Down Expand Up @@ -49,4 +49,4 @@

- **Callback URL mismatch.** Auth0 blocks the login and shows a callback error. Confirm the redirect URL in Auth0's **Allowed Callback URLs** exactly matches the one shown in your Mintlify authentication settings, including protocol and trailing path.
- **Users log in but see no restricted content.** Your groups claim is not reaching Mintlify. Confirm the Auth0 Action adds the claim, that `source` in Mintlify matches the token you set it on (`id_token` or `access_token`), and that `groupsClaim` matches the claim name.
- **Logout does not redirect back.** Auth0 requires the `returnTo` URL in the logout link to be listed under **Allowed Logout URLs** on the application.

Check warning on line 52 in help-center/configure-oauth-with-auth0.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/configure-oauth-with-auth0.mdx#L52

In general, use active voice instead of passive voice ('be listed').
2 changes: 1 addition & 1 deletion migration/document360.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In Document360, navigate to **Content tools > Import and export > Import and exp
</Note>

1. Click **Export project**.
2. Select the export format. Choose **JSON** for a complete project export.
2. Select **JSON** as the export format for a complete project export.
3. In **Include new or modified articles in**, select **All** so the export is not limited to recently modified articles.
4. Select every maintained workspace, language, category, and subcategory.
5. Select **Include media files**.
Expand Down
2 changes: 1 addition & 1 deletion migration/gitbook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| Git Sync export | You are an admin of your GitBook site or need source Markdown, reusable content, private pages, or a stable migration snapshot. |
| Automated scraper | Your GitBook site is public and you want a fast conversion of rendered pages, common blocks, assets, and navigation. |

Use Git Sync for the primary migration when possible. A GitBook site is made up of sections, and a section can have multiple variants, while Git Sync operates at the section level. Export every section that appears on the published site.

Check warning on line 18 in migration/gitbook.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration/gitbook.mdx#L18

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

<Note>
GitBook now calls the content containers inside a site sections. Older GitBook documentation and community scripts call them spaces.
Expand All @@ -29,7 +29,7 @@
2. In the section you want to export, click **Set up** next to **Git Sync** in the section header.
3. From the provider list, click **GitHub Sync** or **GitLab Sync**, then authenticate if you have not connected the provider yet.
4. Select the empty repository and the branch for the export.
5. For the initial sync direction, choose **GitBook → GitHub** or **GitBook → GitLab**.
5. For the initial sync direction, select **GitBook → GitHub** or **GitBook → GitLab**.
6. Start the initial sync. When it finishes, clone or download the repository.
7. Repeat for every section, language, or version that you need to migrate.

Expand Down
2 changes: 1 addition & 1 deletion search-index/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ To configure Claude Code or Cursor manually, or to verify what the CLI changed,

<Steps>
<Step title="Open MCP settings">
1. Open the command palette with <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows).
1. Open the command palette with <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows).
2. Search for **Open MCP settings**.
3. Click **Add custom MCP** to open `mcp.json`.
</Step>
Expand Down