From 6a66bd6818ab3de1ffe2301a09250afa1907d28c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 18:18:05 +0000 Subject: [PATCH 1/4] Fix Vale style warnings across 11 documentation files Convert passive voice to active voice, fix sentence-style capitalization, and update word choice per Vale linter suggestions. Generated-By: mintlify-agent --- agent/workflows.mdx | 2 +- api-playground/troubleshooting.mdx | 2 +- cli/commands.mdx | 4 ++-- cli/preview.mdx | 2 +- components/fields.mdx | 16 ++++++++-------- components/responses.mdx | 6 +++--- components/tooltips.mdx | 2 +- deploy/ci.mdx | 12 ++++++------ guides/configure-automerge.mdx | 4 ++-- organize/navigation.mdx | 6 +++--- status.mdx | 2 +- 11 files changed, 29 insertions(+), 29 deletions(-) diff --git a/agent/workflows.mdx b/agent/workflows.mdx index fb15ff05b..b95cc0257 100644 --- a/agent/workflows.mdx +++ b/agent/workflows.mdx @@ -236,7 +236,7 @@ To toggle a workflow: 2. Click **View Workflows**. 3. Click the toggle next to the workflow you want to disable or enable. -When you re-enable a cron-based workflow, its next run time is recalculated from the current time. +When you re-enable a cron-based workflow, the system recalculates the next run time from the current time. ## Prompts diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index d2805eb85..93d32f21d 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -65,7 +65,7 @@ If your API pages aren't displaying correctly, check these common configuration If you have a custom domain configured, this could be an issue with your reverse proxy. By default, requests made via the API Playground start with a `POST` request to the - `/_mintlify/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET` + `/_mintlify/api/request` path on the docs site. If you configure your reverse proxy to only allow `GET` requests, then all of these requests fail. To fix this, configure your reverse proxy to allow `POST` requests to the `/_mintlify/api/request` path. diff --git a/cli/commands.mdx b/cli/commands.mdx index 48af61361..9b71daf88 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -175,7 +175,7 @@ Manage persistent default values for CLI commands. The configuration saves in `~ mint config [value] ``` -| Subcommand | Description | +| subcommand | Description | | --- | --- | | `set ` | Set a configuration value. | | `get ` | Display a configuration value. | @@ -241,7 +241,7 @@ mint validate [flags] | `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. | - The standalone `mint openapi-check` command is deprecated. Use `mint validate` instead. + Mintlify deprecated the standalone `mint openapi-check` command. Use `mint validate` instead. --- diff --git a/cli/preview.mdx b/cli/preview.mdx index aaf074cc3..89a9a6bdd 100644 --- a/cli/preview.mdx +++ b/cli/preview.mdx @@ -34,7 +34,7 @@ You must authenticate the CLI with your Mintlify account to enable search and th mint login ``` -After you authenticate with the `mint login` command, the CLI stores your credentials in `~/.config/mintlify/config.json` so you stay logged in across sessions. The CLI also prompts you to select a default project, which is used for commands like `mint analytics`. +After you authenticate with the `mint login` command, the CLI stores your credentials in `~/.config/mintlify/config.json` so you stay logged in across sessions. The CLI also prompts you to select a default project, which commands like `mint analytics` use. Once logged in, run `mint dev` to start the local preview with search and the assistant enabled. The assistant uses the same indexed content as your deployed documentation site. diff --git a/components/fields.mdx b/components/fields.mdx index bc0190ae9..9bdb3bed2 100644 --- a/components/fields.mdx +++ b/components/fields.mdx @@ -8,7 +8,7 @@ Use fields to document API parameters and responses. There are two types of fiel ## Parameter field -The `` component is used to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview). +Use the `` component to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview). An example of a parameter field @@ -32,16 +32,16 @@ The `` component is used to define parameters for your APIs or SDKs. Supports `number`, `string`, `boolean`, `object`. -Arrays can be defined using the `[]` suffix. For example `string[]`. +Define arrays using the `[]` suffix. For example `string[]`. - Indicate whether the parameter is required. + Indicate whether you require the parameter. - Indicate whether the parameter is deprecated. + Indicate whether you have deprecated the parameter. @@ -85,17 +85,17 @@ The `` component defines the return values of an API. - Indicate whether the response is required. + Indicate whether you require the response. - Whether a field is deprecated. + Whether you have deprecated a field. - Labels that are shown before the name of the field. + Labels that appear before the name of the field. - Labels that are shown after the name of the field. + Labels that appear after the name of the field. diff --git a/components/responses.mdx b/components/responses.mdx index c0b47bf5c..5298e2e85 100644 --- a/components/responses.mdx +++ b/components/responses.mdx @@ -35,15 +35,15 @@ Use the `` component to define the return values of an API. Many - Whether a field is deprecated or not. + Whether you have deprecated a field or not. - Labels that are shown before the name of the field + Labels that appear before the name of the field - Labels that are shown after the name of the field + Labels that appear after the name of the field diff --git a/components/tooltips.mdx b/components/tooltips.mdx index afdd2e993..3a2364bf2 100644 --- a/components/tooltips.mdx +++ b/components/tooltips.mdx @@ -19,7 +19,7 @@ Use tooltips to provide additional context or definitions when a user hovers ove - Text displayed above the `tip` text. + Text displayed preceding the `tip` text. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index dea03f09d..ccd439e79 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -15,7 +15,7 @@ Use CI checks to lint your docs for errors and provide warnings before you deplo To begin, follow the steps on the [GitHub](/deploy/github) page. - Only access to the repository where your documentation content exists is required, so it is highly recommended to only grant access to that repository. + You only need access to the repository where your documentation content exists, so we highly recommend granting access to that repository only. ## Configuration @@ -357,8 +357,8 @@ toc To add your own vocabulary for the default configuration, create a `styles/config/vocabularies/Mintlify` directory with `accept.txt` and `reject.txt` files. -- `accept.txt`: Words that should be ignored by the Vale linter. For example, product names or uncommon terms. -- `reject.txt`: Words that should be flagged as errors. For example, jargon or words that are not appropriate for the tone of your documentation. +- `accept.txt`: Words that the Vale linter should ignore. For example, product names or uncommon terms. +- `reject.txt`: Words that the Vale linter should flag as errors. For example, jargon or words that are not appropriate for the tone of your documentation. ```text Example Vale file structure /your-project @@ -396,7 +396,7 @@ Use relative paths and include the `stylesPath` in your repository. #### Packages -Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors. Any packages you include in your repository under the correct `stylesPath` are automatically installed and used in your Vale configuration. +Vale supports a range of [packages](https://vale.sh/docs/keys/packages) that check for spelling and style errors. Any packages you include in your repository under the correct `stylesPath` automatically install and run with your Vale configuration. For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they're automatically downloaded and used in your Vale configuration. @@ -415,12 +415,12 @@ To use Vale's in-document comments in MDX files, use MDX-style comments `{/* ... ```mdx {/* vale off */} -This text is ignored by Vale +Vale ignores this text {/* vale on */} ``` -Vale automatically recognizes and respects these comments in MDX files without additional configuration. Use comments to skip lines or sections that should be ignored by the linter. +Vale automatically recognizes and respects these comments in MDX files without additional configuration. Use comments to skip lines or sections that you want the linter to ignore. Do not place `{/* vale off */}` or similar MDX expression comments as direct children of a JSX component between sibling elements. For example, between two `` elements inside a `` component. diff --git a/guides/configure-automerge.mdx b/guides/configure-automerge.mdx index 43decb2d4..e51c7b118 100644 --- a/guides/configure-automerge.mdx +++ b/guides/configure-automerge.mdx @@ -5,7 +5,7 @@ description: "Set up GitHub workflows to automatically merge Mintlify pull reque keywords: ["automerge", "ruleset", "branch protection", "bypass"] --- -Add the Mintlify GitHub App to a ruleset's bypass list so that the app can create and merge pull requests without being blocked by review and status check requirements. This allows you to configure [workflows](/guides/automate-agent) to automatically merge changes to `main`. +Add the Mintlify GitHub App to a ruleset's bypass list so that the app can create and merge pull requests without review and status check requirements blocking it. This allows you to configure [workflows](/guides/automate-agent) to automatically merge changes to `main`. The Mintlify GitHub App must have bypass permissions on **every** ruleset that targets your deploy branch, including rulesets defined at the organization level and the repository level. If any ruleset is missing the bypass entry, the workflow creates a PR, but does not merge it. @@ -44,5 +44,5 @@ Repeat these steps for every ruleset that applies to your deploy branch. Both ** ## Verify the setup -1. **For contributors**: Open a PR targeting `main`. Confirm that it still requires approval and passing status checks before the merge button is enabled. +1. **For contributors**: Open a PR targeting `main`. Confirm that it still requires approval and passing status checks before you can merge. 2. **For workflows**: Trigger a workflow with automerge enabled. Confirm that the workflow runs and successfully merges a PR. diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 421b8a9ab..2666db4ff 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -120,11 +120,11 @@ Use the `root` property to designate a main page for a group. When a group has a Use the `expanded` property to control the default state of a nested group in the navigation sidebar. -- `expanded: true`: Group is expanded by default. -- `expanded: false` or omitted: Group is collapsed by default. +- `expanded: true`: Expands the group by default. +- `expanded: false` or omitted: Collapses the group by default. - The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed. + The `expanded` property only affects nested groups--groups within groups. Top-level groups always expand and you cannot collapse them. ```json diff --git a/status.mdx b/status.mdx index b1cdca9b2..5128f4e01 100644 --- a/status.mdx +++ b/status.mdx @@ -17,7 +17,7 @@ The status page displays the operational status of: ## Subscribing to updates -Subscribe to receive notifications when incidents are detected, incidents are resolved, and when scheduled maintenance is planned. +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**. From b408dd2e7f09b22fcf8696e235db78627f8354bb Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 10 Apr 2026 13:56:32 -0700 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- agent/workflows.mdx | 2 +- cli/commands.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/agent/workflows.mdx b/agent/workflows.mdx index b95cc0257..ca2114767 100644 --- a/agent/workflows.mdx +++ b/agent/workflows.mdx @@ -236,7 +236,7 @@ To toggle a workflow: 2. Click **View Workflows**. 3. Click the toggle next to the workflow you want to disable or enable. -When you re-enable a cron-based workflow, the system recalculates the next run time from the current time. +When you re-enable a cron-based workflow, Mintlify recalculates the next run time from the current time. ## Prompts diff --git a/cli/commands.mdx b/cli/commands.mdx index 9b71daf88..48af61361 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -175,7 +175,7 @@ Manage persistent default values for CLI commands. The configuration saves in `~ mint config [value] ``` -| subcommand | Description | +| Subcommand | Description | | --- | --- | | `set ` | Set a configuration value. | | `get ` | Display a configuration value. | @@ -241,7 +241,7 @@ mint validate [flags] | `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. | - Mintlify deprecated the standalone `mint openapi-check` command. Use `mint validate` instead. + The standalone `mint openapi-check` command is deprecated. Use `mint validate` instead. --- From 5bd3c993214b83523ed6c058644f88936a015a3f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 10 Apr 2026 13:58:02 -0700 Subject: [PATCH 3/4] Apply suggestion from @ethanpalm --- components/tooltips.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/tooltips.mdx b/components/tooltips.mdx index 3a2364bf2..00d23df59 100644 --- a/components/tooltips.mdx +++ b/components/tooltips.mdx @@ -19,7 +19,7 @@ Use tooltips to provide additional context or definitions when a user hovers ove - Text displayed preceding the `tip` text. + Text displayed before the `tip` text. From 15893cbee97e273a86c83ebb34412b9dbf6629d0 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 10 Apr 2026 13:58:59 -0700 Subject: [PATCH 4/4] Apply suggestion from @ethanpalm --- deploy/ci.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/ci.mdx b/deploy/ci.mdx index ccd439e79..7d38b25fd 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -15,7 +15,7 @@ Use CI checks to lint your docs for errors and provide warnings before you deplo To begin, follow the steps on the [GitHub](/deploy/github) page. - You only need access to the repository where your documentation content exists, so we highly recommend granting access to that repository only. + The Mintlify GitHub App only need access to the repository where your documentation content exists. We recommend only granting access to that repository only. ## Configuration