Skip to content

Fix Vale style warnings from PRs merged in the last week #5806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −5
Open

Fix Vale style warnings from PRs merged in the last week #5806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dab0a87
Fix Vale style warnings from PRs merged in the last week
mintlify[bot] May 14, 2026
18d497f
Mirror heading slug update in translations
mintlify[bot] May 14, 2026
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
View file
Open in desktop
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 |
| **Endpoints** | `/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 'Endpoints'.
| **Output** | Search results and page content | Content edits, navigation changes, pull requests |

## Connect to the Mintlify MCP
Expand Down Expand Up @@ -104,13 +104,13 @@
### Content

- **`read`** — Fetch the full MDX of any page on the session branch.
- **`search`** — Find lines matching a substring or regex across every page.
- **`search`** — Find lines matching a substring or regular expression across every page.
- **`edit_page`** — Apply a targeted edit to a page.
- **`write_page`** — Overwrite a page's full MDX content.

### Navigation

- **`list_nodes`** — Walk the navigation tree with optional filters. Filter by `parentId` (use `recursive: true` to include all descendants), one or more node types, or any division scope: `language`, `version`, `tab`, `dropdown`, `anchor`, `product`, or `item`. Results are paginated through an opaque `cursor`.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L113 

In general, use active voice instead of passive voice ('are paginated').
- **`create_node`** — Add a new page, group, tab, anchor, version, language, product, or dropdown.
- **`update_node`** — Update a node's properties in place (rename a group, change an icon, set a default version).
- **`move_node`** — Move a node, including renaming a page's path.
Expand All @@ -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 es/guides/automate-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Configura actualizaciones de documentación automatizadas activada
keywords: ["automatización con agente", "n8n", "GitHub Actions", "actualizaciones automáticas de la documentación"]
---

<div id="what-you-will-build">
<div id="what-youll-build">
## Qué vas a construir
</div>

Expand Down
2 changes: 1 addition & 1 deletion fr/guides/automate-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Configurez des mises à jour de documentation automatisées décle
keywords: ["automatisation avec agent", "n8n", "GitHub Actions", "mises à jour automatiques de la documentation"]
---

<div id="what-you-will-build">
<div id="what-youll-build">
## Ce que vous allez construire
</div>

Expand Down
2 changes: 1 addition & 1 deletion guides/automate-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"]
---

## What you will build
## What you'll build

An automation that updates your documentation when you push code to your main branch. You can build this workflow on multiple platforms, including GitHub Actions and n8n. It watches your code repository and then calls the agent API to update your documentation in a separate documentation repository.

Expand All @@ -30,7 +30,7 @@

GitHub Actions is the simplest option if your code is already on GitHub. No additional services required.

## GitHub Actions prerequisites

Check warning on line 33 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L33 

'GitHub Actions prerequisites' should use sentence-style capitalization.

- GitHub Actions enabled on your code and documentation repositories
- [Mintlify GitHub App](/deploy/github) installed in both your code and documentation repositories
Expand Down Expand Up @@ -167,7 +167,7 @@

3. After the workflow runs, check your documentation repository for a new branch and pull request with documentation updates.

## GitHub Actions troubleshooting

Check warning on line 170 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L170 

'GitHub Actions troubleshooting' should use sentence-style capitalization.

### Workflow not running
- Verify that you enabled GitHub Actions in your code repository.
Expand Down Expand Up @@ -259,7 +259,7 @@
- Payload URL: Paste your n8n webhook URL
- Content type: `application/json`
- Which events would you like to trigger this webhook?
- Select **Let me select individual events.**

Check warning on line 262 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L262 

Avoid first-person pronouns such as 'me'.
- Select only **Push events**.
- Select **Active**
6. Click **Add webhook**.
Expand Down
2 changes: 1 addition & 1 deletion zh/guides/automate-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "使用 Mintlify agent API 设置由代码变更触发的自动化
keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"]
---

<div id="what-you-will-build">
<div id="what-youll-build">
## 你将构建的内容
</div>

Expand Down
Loading