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
4 changes: 4 additions & 0 deletions .vale/styles/Mintlify/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ exceptions:
- API
- ASCII
- ASP
- AVIF
- AWS
- BETA
- BMP
- CAA
- CDN
- CIDR
Expand Down Expand Up @@ -69,6 +71,7 @@ exceptions:
- LTS
- MCP
- MDX
- MOV
- NAT
- NET
- NEW
Expand Down Expand Up @@ -96,6 +99,7 @@ exceptions:
- ROI
- RPC
- RSA
- RSS
- SAML
- SCIM
- SCM
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/Mintlify/WordList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ swap:
'[\.]+apk': APK
'3\-D': 3D
"un(?:check|select)": clear
(?<!\b(?:and|or) )above(?! (?:all|the|an?)\b): preceding
(?<!\b(?:and|or) )(?<!\brank(?:s|ed|ing)? \w+ )above(?! (?:all|the|an?)\b): preceding
account name: username
Ajax: AJAX
a\.k\.a|aka: or|also known as
Expand Down
2 changes: 2 additions & 0 deletions .vale/styles/config/vocabularies/Mintlify/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ MySQL
namespaced
namespaces?
Nango
narratable
(?i)navbar
Next.js
(?i)nginx
Expand Down Expand Up @@ -537,6 +538,7 @@ Webflow
Webflow's
WebKit
WebM
WebMCP
WebP
WebSocket
WebStorm
Expand Down
4 changes: 2 additions & 2 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@

You can also ask the agent about automation activity, such as recent runs, failures, or credit use.

- "How can I make my automations more credit efficient?"

Check warning on line 154 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L154

Avoid first-person pronouns such as ' I '.

Check warning on line 154 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L154

Avoid first-person pronouns such as 'my'.
- "Why did the last run of the code change automation fail?"

### Trigger automations from Slack messages
Expand Down Expand Up @@ -193,9 +193,9 @@

To change a teammate's permissions, update their role on the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.

## Use the agent in the Slack sidepanel
## Use the agent in the Slack side panel

Chat with `@mintlify` in the Slack side panel to ask questions or request documentation updates without posting in a channel. The sidepanel agent behaves like the Slack agent: same permissions, same tools, and the same review process for any changes it makes.
Chat with `@mintlify` in the Slack side panel to ask questions or request documentation updates without posting in a channel. The side panel agent behaves like the Slack agent: same permissions, same tools, and the same review process for any changes it makes.

## Best practices

Expand Down
2 changes: 1 addition & 1 deletion analytics/traffic-classification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@
| View | Recorded by | When |
|------|-------------|------|
| HTML page view | The docs site in the browser | JavaScript runs after a page renders and sends a page view event. Clients that do not run JavaScript never produce this event. |
| Markdown view | Mintlify's edge | A page is served as Markdown by any rule above, or `llms.txt`, `llms-full.txt`, or `skill.md` is fetched. The edge also records a Markdown view when a known AI agent from the list above requests an HTML page. |
| Markdown view | Mintlify's edge | A page is served as Markdown by any preceding rule, or `llms.txt`, `llms-full.txt`, or `skill.md` is fetched. The edge also records a Markdown view when a known AI agent from the preceding list requests an HTML page. |

Check warning on line 32 in analytics/traffic-classification.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/traffic-classification.mdx#L32

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

Each view carries the request path, referrer, IP address, and user agent. Mintlify stores timestamps in UTC.

## How views are categorized

Check warning on line 36 in analytics/traffic-classification.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/traffic-classification.mdx#L36

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

Classification uses only the user agent string. Mintlify checks it, case-insensitively, against four ordered lists of known bot and agent identifiers. The first list that matches sets the category. No match means `human`. See the [full user agent list](#full-user-agent-list) for every identifier in each category.

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

`ChatGPT-User`, `chatgpt`, `Claude-User`, `claude-code`, `Cursor`, `Opencode`, `WarpBot`, `Perplexity-User`, `Google-Agent`, `GoogleAgent`, `Google-NotebookLM`, `Google-Read-Aloud`, `MistralAI-User`, `Copilot`, `Amzn-User`, `DuckAssistBot`, `xAI-SearchBot`, `Grok-DeepSearch`, `Meta-ExternalFetcher`, `Kimi-User`, `Qwen-User`, `Amazon-Bedrock-AgentCore-Browser`, `Shap-User`

### Search index

Check warning on line 73 in analytics/traffic-classification.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/traffic-classification.mdx#L73

'Search index' should use sentence-style capitalization.

`OAI-SearchBot`, `Claude-SearchBot`, `PerplexityBot`, `Google-InspectionTool`, `Googlebot`, `MistralAI-Index`, `Bingbot`, `msnbot`, `Amzn-SearchBot`, `meta-webindexer`, `Kimi-SearchBot`, `TikTokSpider`, `Baiduspider`, `YouBot`, `Petalbot`, `YisouSpider`, `Sogou web spider`, `Coveobot`, `amazon-kendra`, `Algolia Crawler`, `ref-tools-crawler`, `ShapBot`, `AteveSearchSourceUrlDiscovery`, `YandexBot`, `YandexMobileBot`, `YandexAccessibilityBot`, `YandexRenderResourcesBot`, `YandexImages`, `YandexNews`, `YandexWebmaster`, `Yeti/`, `360Spider`, `SeznamBot`, `Exabot`

Expand All @@ -84,4 +84,4 @@

### Excluded internal traffic

Requests whose user agent contains `mintlify-revalidation` or `Mintlify-LinkChecker` come from Mintlify's own infrastructure and are removed before any counting.

Check warning on line 87 in analytics/traffic-classification.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/traffic-classification.mdx#L87

In general, use active voice instead of passive voice ('are removed').
2 changes: 1 addition & 1 deletion automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Each automation has a default trigger that controls when it runs. To change the
- **Code change**: Runs when a pull request merges in a connected source code repository. You must specify at least one source repository. Click **Add repo** to trigger on pull requests from more than one repository. For each repository, you can optionally set **Exclude author** to ignore pull requests from a specific author, and **Listening to changes in** to only trigger on pull requests with changes under a specific path.
- **Custom schedule**: Runs on a recurring schedule you define. Pick a preset (Daily, Every Monday, Every Friday, or Twice weekly) and a start hour, or select **Custom cron** and enter a standard 5-field cron expression (`minute hour day month weekday`). Automations queue within 10 minutes of the scheduled time.
- **Integration**: Runs when a selected event occurs in a connected shared integration or when a new message posts to a selected Slack channel. Available for custom automations. Select the integration and event, then complete any additional event fields that appear. For Slack triggers, pick one or more channels that you have added the [Mintlify Slack app](/agent/slack) to.
- **Webhook**: Runs when an authenticated `POST` request hits the automation's webhook endpoint. Available for custom automations only. Save the automation first; the trigger card then shows the webhook URL and a **Copy auth header** action for the `Authorization: Bearer <api-key>` header. Supply an unexpired organization API key with write access from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page. Use this to trigger a run from a CI/CD pipeline, release script, or internal tool. See [Trigger automation webhook](/api/automations/webhook) for the endpoint and rate limits.
- **Webhook**: Runs when an authenticated `POST` request hits the automation's webhook endpoint. Available for custom automations only. Save the automation first. The trigger card then shows the webhook URL and a **Copy auth header** action for the `Authorization: Bearer <api-key>` header. Supply an unexpired organization API key with write access from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page. Use this to trigger a run from a CI/CD pipeline, release script, or internal tool. See [Trigger automation webhook](/api/automations/webhook) for the endpoint and rate limits.

#### Filter code change triggers

Expand Down
2 changes: 1 addition & 1 deletion es/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Cada automatización tiene un activador predeterminado que controla cuándo se e
- **Cambio de código**: se ejecuta cuando se fusiona una pull request en un repositorio de código fuente conectado. Debes especificar al menos un repositorio de origen. Haz clic en **Add repo** para activar la automatización con pull requests de más de un repositorio. Para cada repositorio, puedes configurar opcionalmente **Exclude author** para ignorar pull requests de un autor específico, y **Listening to changes in** para activar el disparador solo con pull requests que tengan cambios bajo una ruta específica.
- **Programación personalizada**: se ejecuta de forma recurrente según la programación que definas. Elige un preajuste (**Daily**, **Every Monday**, **Every Friday** o **Twice weekly**) y una hora de inicio, o selecciona **Custom cron** e introduce una expresión cron estándar de 5 campos (`minute hour day month weekday`). Los valores de cron se almacenan en UTC; el dashboard convierte las horas de los preajustes hacia y desde tu zona horaria local. Las automatizaciones se ponen en cola dentro de los 10 minutos siguientes a la hora programada.
- **Integración**: se ejecuta cuando ocurre un evento seleccionado en una integración compartida conectada, o cuando se publica un nuevo mensaje de nivel superior en un canal de Slack seleccionado. Está disponible para automatizaciones personalizadas. Selecciona la integración y el evento y completa los campos adicionales que aparezcan. Para activadores de Slack, elige uno o más canales a los que se haya añadido la [app de Mintlify para Slack](/es/agent/slack).
- **Webhook**: se ejecuta cuando una solicitud `POST` autenticada llega al endpoint de webhook de la automatización. Solo está disponible para automatizaciones personalizadas. Guarda primero la automatización; la tarjeta del activador muestra entonces la URL del webhook y una acción **Copy auth header** para el encabezado `Authorization: Bearer <api-key>`. Proporciona una clave de API de organización sin caducar con acceso de escritura desde la página [API keys](https://app.mintlify.com/settings/organization/api-keys). Úsalo para lanzar una ejecución desde un pipeline de CI/CD, un script de publicación o una herramienta interna. Consulta [Activar webhook de automatización](/es/api/automations/webhook) para conocer el endpoint y los límites de tasa.
- **Webhook**: se ejecuta cuando una solicitud `POST` autenticada llega al endpoint de webhook de la automatización. Solo está disponible para automatizaciones personalizadas. Guarda primero la automatización. La tarjeta del activador muestra entonces la URL del webhook y una acción **Copy auth header** para el encabezado `Authorization: Bearer <api-key>`. Proporciona una clave de API de organización sin caducar con acceso de escritura desde la página [API keys](https://app.mintlify.com/settings/organization/api-keys). Úsalo para lanzar una ejecución desde un pipeline de CI/CD, un script de publicación o una herramienta interna. Consulta [Activar webhook de automatización](/es/api/automations/webhook) para conocer el endpoint y los límites de tasa.

<div id="filter-code-change-triggers">
#### Filtrar activadores de cambio de código
Expand Down
2 changes: 1 addition & 1 deletion es/help-center/publish-button-disabled-invalid-mdx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Mientras una página tiene MDX no válido o YAML de frontmatter no válido, esas
Si el tooltip indica una sola página con errores, normalmente es la que estás editando. Si indica más de una, o no sabes qué página tiene el error, revisa cada página que hayas modificado en la branch:

1. Haz clic en **Publish** en la barra de herramientas para abrir el menú de publicación. El menú lista todos los archivos modificados en tu branch.
2. Abre cada archivo modificado por turno y busca errores de parseo en el modo source (ver más abajo). Las páginas que se parsean correctamente se muestran con normalidad; la página rota muestra el error.
2. Abre cada archivo modificado por turno y busca errores de parseo en el modo source (ver más abajo). Las páginas que se parsean correctamente se muestran con normalidad. La página rota muestra el error.

<div id="fix-the-error-manually">
## Corregir el error manualmente
Expand Down
2 changes: 1 addition & 1 deletion fr/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Chaque automatisation possède un déclencheur par défaut qui contrôle son mom
- **Modification de code** : s'exécute lorsqu'une pull request est fusionnée dans un dépôt de code source connecté. Vous devez spécifier au moins un dépôt source. Cliquez sur **Add repo** pour déclencher l'automatisation sur des pull requests provenant de plusieurs dépôts. Pour chaque dépôt, vous pouvez éventuellement définir **Exclude author** pour ignorer les pull requests d'un auteur spécifique, et **Listening to changes in** pour ne déclencher que sur les pull requests dont les modifications se trouvent sous un chemin spécifique.
- **Calendrier personnalisé** : s'exécute selon un calendrier récurrent que vous définissez. Choisissez un préréglage (**Daily**, **Every Monday**, **Every Friday** ou **Twice weekly**) et une heure de début, ou sélectionnez **Custom cron** et saisissez une expression cron standard à 5 champs (`minute heure jour mois jour_de_la_semaine`). Les valeurs cron sont stockées en UTC ; le dashboard convertit les heures des préréglages depuis et vers votre fuseau horaire local. Les automatisations sont mises en file d'attente dans les 10 minutes suivant l'heure planifiée.
- **Intégration** : s'exécute lorsqu'un événement sélectionné se produit dans une intégration partagée connectée, ou lorsqu'un nouveau message de premier niveau est publié dans un canal Slack sélectionné. Disponible pour les automatisations personnalisées. Sélectionnez l'intégration et l'événement, puis remplissez les champs supplémentaires affichés. Pour les déclencheurs Slack, choisissez un ou plusieurs canaux auxquels l'[application Mintlify pour Slack](/fr/agent/slack) a été ajoutée.
- **Webhook** : s'exécute lorsqu'une requête `POST` authentifiée atteint le point de terminaison webhook de l'automatisation. Disponible uniquement pour les automatisations personnalisées. Enregistrez d'abord l'automatisation ; la carte du déclencheur affiche alors l'URL du webhook et une action **Copy auth header** pour l'en-tête `Authorization: Bearer <api-key>`. Fournissez une clé d'API d'organisation non expirée avec accès en écriture depuis la page [API keys](https://app.mintlify.com/settings/organization/api-keys). Utilisez-le pour déclencher une exécution depuis un pipeline CI/CD, un script de publication ou un outil interne. Consultez [Déclencher un webhook d'automatisation](/fr/api/automations/webhook) pour le point de terminaison et les limites de débit.
- **Webhook** : s'exécute lorsqu'une requête `POST` authentifiée atteint le point de terminaison webhook de l'automatisation. Disponible uniquement pour les automatisations personnalisées. Enregistrez d'abord l'automatisation. La carte du déclencheur affiche alors l'URL du webhook et une action **Copy auth header** pour l'en-tête `Authorization: Bearer <api-key>`. Fournissez une clé d'API d'organisation non expirée avec accès en écriture depuis la page [API keys](https://app.mintlify.com/settings/organization/api-keys). Utilisez-le pour déclencher une exécution depuis un pipeline CI/CD, un script de publication ou un outil interne. Consultez [Déclencher un webhook d'automatisation](/fr/api/automations/webhook) pour le point de terminaison et les limites de débit.

<div id="filter-code-change-triggers">
#### Filtrer les déclencheurs de modification de code
Expand Down
2 changes: 1 addition & 1 deletion fr/help-center/publish-button-disabled-invalid-mdx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Tant qu'une page contient un MDX non valide ou un frontmatter YAML non valide, c
Si l'infobulle indique une seule page en erreur, il s'agit généralement de celle que vous êtes en train de modifier. Si elle en indique plusieurs, ou si vous ne savez pas laquelle contient l'erreur, examinez chaque page que vous avez modifiée sur la branch :

1. Cliquez sur **Publish** dans la barre d'outils pour ouvrir le menu de publication. Le menu liste tous les fichiers modifiés sur votre branch.
2. Ouvrez tour à tour chaque fichier modifié et cherchez les erreurs de parsing en mode source (voir ci-dessous). Les pages qui parsent correctement s'affichent normalement ; la page en erreur affiche l'erreur.
2. Ouvrez tour à tour chaque fichier modifié et cherchez les erreurs de parsing en mode source (voir ci-dessous). Les pages qui parsent correctement s'affichent normalement. La page en erreur affiche l'erreur.

<div id="fix-the-error-manually">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

When the Mintlify agent or an automation opens a pull request, it targets the deploy branch configured for your project (usually `main`). This is the branch Mintlify builds your live site from, so PRs land there by default and publish on merge.

If you want changes to go somewhere else, the control depends on how the run was started.

Check warning on line 9 in help-center/agent-opens-pull-requests-against-deploy-branch.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/agent-opens-pull-requests-against-deploy-branch.mdx#L9

In general, use active voice instead of passive voice ('was started').

## Agent runs in Slack, the editor, or the dashboard

Expand All @@ -25,5 +25,5 @@

## Related settings

- [Choose how the agent publishes changes](/agent/index#choose-how-the-agent-publishes-changes) — pull request vs. direct push, and how branch protection interacts with each.
- [Git Settings](https://app.mintlify.com/settings/project/git-settings) — change the deploy branch or the docs subdirectory the deployment builds from.
- [Choose how the agent publishes changes](/agent/index#choose-how-the-agent-publishes-changes): Pull request versus direct push, and how branch protection interacts with each.
- [Git Settings](https://app.mintlify.com/settings/project/git-settings): Change the deploy branch or the docs subdirectory the deployment builds from.
2 changes: 1 addition & 1 deletion help-center/publish-button-disabled-invalid-mdx.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Publish button disabled because of invalid MDX"
description: "Why the Publish button in the editor is disabled with the message 'Fix invalid MDX before publishing' and how to find and fix the page with the error."

Check warning on line 3 in help-center/publish-button-disabled-invalid-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/publish-button-disabled-invalid-mdx.mdx#L3

In general, use active voice instead of passive voice ('is disabled').
keywords: ["publish disabled", "fix invalid MDX before publishing", "invalid MDX", "publish button greyed out", "cannot publish", "MDX error", "frontmatter error", "source mode"]
---

Expand All @@ -19,7 +19,7 @@
If the tooltip reports one broken page, it's usually the page you're editing. If it reports more than one, or you don't know which page has the error, check each page you've changed on the branch:

1. Click **Publish** in the toolbar to open the publish menu. The menu lists every changed file on your branch.
2. Open each changed file in turn and look for parsing errors in source mode (see below). Pages that parse successfully render normally; the broken page shows the error.
2. Open each changed file in turn and look for parsing errors in source mode (see below). Pages that parse successfully render normally. The broken page shows the error.

## Fix the error manually

Expand Down
2 changes: 1 addition & 1 deletion zh/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx';
- **代码变更(Code change)**:当已连接的源代码仓库中有 pull request 合并时运行。你必须至少指定一个源仓库。点击 **Add repo** 可让来自多个仓库的 pull request 触发该自动化。对于每个仓库,你可以选择设置 **Exclude author** 来忽略来自特定作者的 pull request,以及 **Listening to changes in** 仅在特定路径下有变更的 pull request 时触发。
- **自定义计划(Custom schedule)**:按你定义的周期性计划运行。选择一个预设(**Daily**、**Every Monday**、**Every Friday** 或 **Twice weekly**)以及起始小时,或选择 **Custom cron** 并输入标准的 5 段式 cron 表达式(`minute hour day month weekday`)。cron 值以 UTC 存储;控制台会在你的本地时区与预设小时之间进行转换。自动化会在预定时间的 10 分钟内进入队列。
- **集成(Integration)**:当已连接的共享集成中发生所选事件时运行,或当在所选 Slack 频道中发布新的顶层消息时运行。此选项适用于自定义自动化。请选择集成和事件,并填写出现的任何其他事件字段。对于 Slack 触发器,请选择一个或多个已添加 [Mintlify Slack 应用](/zh/agent/slack)的频道。
- **Webhook**:当一个已认证的 `POST` 请求命中自动化的 webhook 端点时运行。仅适用于自定义自动化。先保存自动化;触发器卡片随后会显示 webhook URL 和用于 `Authorization: Bearer <api-key>` 请求头的 **Copy auth header** 操作。在 [API keys](https://app.mintlify.com/settings/organization/api-keys) 页面提供一个具有写入权限且未过期的组织 API 密钥。可用于从 CI/CD 流水线、发布脚本或内部工具触发运行。有关端点和速率限制,请参见[触发自动化 webhook](/zh/api/automations/webhook)。
- **Webhook**:当一个已认证的 `POST` 请求命中自动化的 webhook 端点时运行。仅适用于自定义自动化。先保存自动化。触发器卡片随后会显示 webhook URL 和用于 `Authorization: Bearer <api-key>` 请求头的 **Copy auth header** 操作。在 [API keys](https://app.mintlify.com/settings/organization/api-keys) 页面提供一个具有写入权限且未过期的组织 API 密钥。可用于从 CI/CD 流水线、发布脚本或内部工具触发运行。有关端点和速率限制,请参见[触发自动化 webhook](/zh/api/automations/webhook)。

<div id="filter-code-change-triggers">
#### 过滤代码变更触发器
Expand Down
2 changes: 1 addition & 1 deletion zh/help-center/publish-button-disabled-invalid-mdx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ keywords: ["publish disabled", "fix invalid MDX before publishing", "invalid MDX
如果提示只显示一个损坏的页面,通常就是你当前正在编辑的那一个。如果显示多个,或者你不确定是哪个页面有错误,请检查你在分支上更改过的每个页面:

1. 点击工具栏中的 **Publish** 打开发布菜单。菜单会列出你分支上所有已更改的文件。
2. 依次打开每个已更改的文件,并在 source 模式下查找解析错误(见下文)。能够正常解析的页面会正常显示;出错的页面会显示错误。
2. 依次打开每个已更改的文件,并在 source 模式下查找解析错误(见下文)。能够正常解析的页面会正常显示。出错的页面会显示错误。

<div id="fix-the-error-manually">

Expand Down
Loading