From 0d02d88f757e50dfab0db62a44e02c7f3f38e34a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 7 May 2026 16:33:54 +0000 Subject: [PATCH 1/2] Fix style consistency issues across docs Generated-By: mintlify-agent --- ai/mintlify-mcp.mdx | 2 +- ai/model-context-protocol.mdx | 2 +- api-playground/managing-page-visibility.mdx | 2 +- contact-support.mdx | 2 +- deploy/ci.mdx | 2 +- deploy/github.mdx | 4 ++-- deploy/gitlab.mdx | 2 +- guides/auth0.mdx | 4 ++-- status.mdx | 4 ++-- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index 834aa3f6b..822db639b 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -39,7 +39,7 @@ Connecting requires an interactive OAuth login against your Mintlify account. Th 4. Select **Add** and complete the OAuth login. - 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. diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index b5dec89f9..589e7f849 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -354,7 +354,7 @@ Connect to the Mintlify MCP server to search this documentation site within your - 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, select the contextual menu, then select **Connect to Cursor** or **Connect to VS Code** to connect the Mintlify MCP server to the IDE of your choice. diff --git a/api-playground/managing-page-visibility.mdx b/api-playground/managing-page-visibility.mdx index c47cd6b0b..3d1ea6c1d 100644 --- a/api-playground/managing-page-visibility.mdx +++ b/api-playground/managing-page-visibility.mdx @@ -29,7 +29,7 @@ Common use cases for `x-excluded` are: - 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. diff --git a/contact-support.mdx b/contact-support.mdx index 614b7646b..ed1261db9 100644 --- a/contact-support.mdx +++ b/contact-support.mdx @@ -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 support@mintlify.com. 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 support@mintlify.com. 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`. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index ba5d8f849..4c4e2065a 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -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, select the **Checks** tab, then select the Mintlify broken links check. The results list any files with broken links found in the pull request. ### Vale diff --git a/deploy/github.mdx b/deploy/github.mdx index 0724faf29..83c86d67c 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -26,7 +26,7 @@ If you skipped connecting your own Git repository during onboarding, your docume 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, then select **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. @@ -42,7 +42,7 @@ If you skipped connecting your own Git repository during onboarding, your docume 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, then select **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. diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index f695e1239..870238f12 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -16,7 +16,7 @@ When you open [Git Settings](https://dashboard.mintlify.com/settings/deployment/ - 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, select **Connect to GitLab** and then select **Continue**. diff --git a/guides/auth0.mdx b/guides/auth0.mdx index 267f13cbc..b77799abb 100644 --- a/guides/auth0.mdx +++ b/guides/auth0.mdx @@ -5,7 +5,7 @@ keywords: ["Auth0", "OAuth flow"] --- - **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. ## Overview @@ -14,7 +14,7 @@ This guide walks you through setting up Auth0 as an authentication provider for - 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**. Select **Create Application**, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then select **Create**. ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) diff --git a/status.mdx b/status.mdx index 5128f4e01..67a5b820a 100644 --- a/status.mdx +++ b/status.mdx @@ -20,8 +20,8 @@ The status page displays the operational status of: Subscribe to receive notifications when we detect incidents, resolve incidents, and plan scheduled maintenance. 1. Navigate to [status.mintlify.com](https://status.mintlify.com). -2. Click **Subscribe to updates**. -3. Choose your preferred notification method (email, RSS, or RSS via Slack). +2. Select **Subscribe to updates**. +3. Select your preferred notification method (email, RSS, or RSS via Slack). ## Reporting issues From 4249de8081f9dc81463215d90a2fb810b20aeaa9 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 7 May 2026 14:12:38 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- ai/model-context-protocol.mdx | 2 +- deploy/ci.mdx | 2 +- deploy/github.mdx | 6 ++++-- deploy/gitlab.mdx | 2 +- guides/auth0.mdx | 2 +- status.mdx | 4 ++-- 6 files changed, 10 insertions(+), 8 deletions(-) diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 589e7f849..797509ff5 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -354,7 +354,7 @@ Connect to the Mintlify MCP server to search this documentation site within your - At the top of this page, select the contextual menu, then select **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. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index 4c4e2065a..9bd7c11f3 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -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, select the **Checks** tab, then select the Mintlify broken links check. The results list 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 diff --git a/deploy/github.mdx b/deploy/github.mdx index 83c86d67c..4a7ed3b17 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -26,7 +26,8 @@ If you skipped connecting your own Git repository during onboarding, your docume The clone option automatically creates a copy of your documentation in your GitHub account. - 1. Select **GitHub** as your provider, then select **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. @@ -42,7 +43,8 @@ If you skipped connecting your own Git repository during onboarding, your docume 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, then select **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. diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index 870238f12..9e366e2ae 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -16,7 +16,7 @@ When you open [Git Settings](https://dashboard.mintlify.com/settings/deployment/ - On the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page, select **Connect to GitLab** and then select **Continue**. + On the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page, click **Connect to GitLab** and then click **Continue**. diff --git a/guides/auth0.mdx b/guides/auth0.mdx index b77799abb..8e09fc242 100644 --- a/guides/auth0.mdx +++ b/guides/auth0.mdx @@ -14,7 +14,7 @@ This guide walks you through setting up Auth0 as an authentication provider for - Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Select **Create Application**, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then select **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**. ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) diff --git a/status.mdx b/status.mdx index 67a5b820a..5128f4e01 100644 --- a/status.mdx +++ b/status.mdx @@ -20,8 +20,8 @@ The status page displays the operational status of: Subscribe to receive notifications when we detect incidents, resolve incidents, and plan scheduled maintenance. 1. Navigate to [status.mintlify.com](https://status.mintlify.com). -2. Select **Subscribe to updates**. -3. Select your preferred notification method (email, RSS, or RSS via Slack). +2. Click **Subscribe to updates**. +3. Choose your preferred notification method (email, RSS, or RSS via Slack). ## Reporting issues