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/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| :-- | :-- | :-- |
| **Audience** | Your end users | Your team |
| **Access** | Read and search published pages | Read, edit, restructure, save |
| **Endpoint** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L23

Use 'endpoints?' instead of 'Endpoint'.
| **Output** | Search results and page content | Content edits, navigation changes, pull requests |

## Connect to the Mintlify MCP
Expand All @@ -39,7 +39,7 @@
4. Select **Add** and complete the OAuth login.
</Step>
<Step title="Use the MCP in a chat">
Select the attachments button (the plus icon) and choose your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt.
Select the attachments button (the plus icon), then select your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt.
</Step>
</Steps>
</Tab>
Expand Down Expand Up @@ -134,8 +134,8 @@
After you connect the Mintlify MCP, you can drive it with natural-language prompts. For example:

- _"Check out a branch called `add-billing-faq` and create a new page under the FAQ group titled 'Billing'. Draft answers for the five questions in this Linear issue."_
- _"Find every page that mentions the deprecated `legacy_token` field and update the example to use `api_key` instead. Save as a PR titled 'docs: replace legacy\_token references'."_

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L137

Did you really mean 'legacy_token'?
- _"Reorganize the API reference: move the webhooks pages into a new group called 'Webhooks' and update the icons to match the rest of the section."_

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L138

Use 'REST' instead of 'rest'.

## Best practices

Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -354,7 +354,7 @@

<Tabs>
<Tab title="Contextual menu">
At the top of this page, select the contextual menu and choose **Connect to Cursor** or **Connect to VS Code** to connect the Mintlify MCP server to the IDE of your choice.
At the top of this page, click the contextual menu, then click **Connect to Cursor** or **Connect to VS Code** to connect the Mintlify MCP server to the IDE of your choice.
</Tab>
<Tab title="Claude">

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 @@ -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 All @@ -29,7 +29,7 @@
- Deprecated endpoints that you don't want to document.
- Beta features that are not ready for public documentation.

## Implementation
## Implementation

Add the `x-hidden` or `x-excluded` extension under the HTTP method in your OpenAPI specification.

Expand Down
2 changes: 1 addition & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Send us a message from your [dashboard](https://dashboard.mintlify.com/). Select

## Contact via email

If you can't access your dashboard, please email us at <a href="mailto:support@mintlify.com">support@mintlify.com</a>. Please include the URL of your [dashboard](https://dashboard.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `dashboard.mintlify.com/your-org/your-deployment`.
If you can't access your dashboard, email us at <a href="mailto:support@mintlify.com">support@mintlify.com</a>. Include the URL of your [dashboard](https://dashboard.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `dashboard.mintlify.com/your-org/your-deployment`.
2 changes: 1 addition & 1 deletion deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When enabling checks, you can choose to run them at a `Warning` or `Blocking` le

Similar to how the [CLI link checker](/cli/commands#mint-broken-links) works on your local machine, the broken link CI check automatically searches your documentation content for broken internal links between pages within your site. It does not check external links to other websites.

To see detailed results for broken links on a pull request, click the **Checks** tab and select the Mintlify broken links check. The results lists any files with broken links found in the pull request.
To see detailed results for broken links on a pull request, click the **Checks** tab, then click the Mintlify broken links check. The results list any files with broken links found in the pull request.

### Vale

Expand Down
6 changes: 4 additions & 2 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
<Accordion title="One-click clone (recommended)">
The clone option automatically creates a copy of your documentation in your GitHub account.

1. Select **GitHub** as your provider and choose **Clone**.
1. Select **GitHub** as your provider.
2. Click **Clone**.
2. Authorize with GitHub when prompted.
3. Select the GitHub organization where you want to create the repository.
4. Confirm the clone. Mintlify copies your documentation files into a new repository.
Expand All @@ -42,7 +43,8 @@
If you prefer to set up your repository manually:

1. Download your documentation as a zip file so that you have a backup of your files.
2. Select **GitHub** as your provider and choose **Continue setup**.
2. Select **GitHub** as your provider.
3. Click **Continue setup**.
3. Authorize with GitHub when prompted.
4. Select your organization, repository, and branch.
5. Optionally specify a subdirectory if your docs are not at the repository root.
Expand All @@ -53,7 +55,7 @@

After completing either path, install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app).

## Install the GitHub App

Check warning on line 58 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L58

'Install the GitHub App' should use sentence-style capitalization.

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand Down Expand Up @@ -127,7 +129,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues

Check warning on line 132 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L132

'GitHub App connection issues' should use sentence-style capitalization.

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -144,7 +146,7 @@

### Feedback add-ons are unavailable

The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility.

Check warning on line 149 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L149

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

If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings.

Expand Down
2 changes: 1 addition & 1 deletion deploy/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When you open [Git Settings](https://dashboard.mintlify.com/settings/deployment/

<Steps>
<Step title="Select GitLab as your provider">
On the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page, select **Connect to GitLab** and click **Continue**.
On the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page, click **Connect to GitLab** and then click **Continue**.
</Step>
<Step title="Download your content">
<Tip>
Expand Down
4 changes: 2 additions & 2 deletions guides/auth0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
---

<Note>
**Security Disclaimer**: While we provide this guide to help you integrate Auth0 with Mintlify, please consult with your security team before implementing any authentication solution. Mintlify is not responsible for any security issues that may arise from your specific implementation.
**Security Disclaimer**: While we provide this guide to help you integrate Auth0 with Mintlify, consult with your security team before implementing any authentication solution. Mintlify is not responsible for any security issues that may arise from your specific implementation.
</Note>

## Overview
Expand All @@ -14,12 +14,12 @@

<Steps>
<Step title="Create a Regular Web Application in Auth0">
Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click **Create Application**, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.

<Frame>![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png)</Frame>
</Step>
<Step title="Get client information">
After creating your application, you'll be taken to the application settings page. Here, you'll find the essential credentials needed for the OAuth integration:

Check warning on line 22 in guides/auth0.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/auth0.mdx#L22

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

<Frame>![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png)</Frame>

Expand Down
Loading