From f771a0f10dcba7d79e168ac499eb38fff2c78745 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 3 Sep 2026 18:15:56 +0000 Subject: [PATCH 1/2] docs: document mint test and update editor sidebar and collaboration behavior --- cli/commands.mdx | 26 +++++++++++++++++++++++++- editor/collaborate.mdx | 2 +- editor/pages.mdx | 2 +- editor/settings.mdx | 2 +- es/cli/commands.mdx | 28 +++++++++++++++++++++++++++- es/editor/collaborate.mdx | 2 +- es/editor/pages.mdx | 2 +- es/editor/settings.mdx | 2 +- fr/cli/commands.mdx | 28 +++++++++++++++++++++++++++- fr/editor/collaborate.mdx | 2 +- fr/editor/pages.mdx | 2 +- fr/editor/settings.mdx | 2 +- zh/cli/commands.mdx | 28 +++++++++++++++++++++++++++- zh/editor/collaborate.mdx | 2 +- zh/editor/pages.mdx | 2 +- zh/editor/settings.mdx | 2 +- 16 files changed, 118 insertions(+), 16 deletions(-) diff --git a/cli/commands.mdx b/cli/commands.mdx index c2f5d3f165..99a92f59f5 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -631,6 +631,31 @@ The overall score uses weighted scoring, so higher-impact checks contribute more --- +## `mint test` + +Test the code examples in your documentation with a local coding agent. Requires authentication with `mint login`. + +```bash +mint test +``` + +Run the command from your docs directory. It scans your pages for fenced code blocks, checks which pages contain testable examples, asks a coding agent to generate tests for each page, runs the generated tests, and reports which pages pass or fail. + +`mint test` runs coding agents through their SDKs, which you install separately: + +| Agent | Installation | +| --- | --- | +| Claude (default) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | +| Codex | `npm install @openai/codex-sdk` | + +In interactive terminals, the command opens a guided interface where you select a coding agent and the pages to test, watch live progress, and review results, including previews of the generated test files. If a previous run was interrupted, you can resume it, and past runs are saved so you can revisit their reports. + +In non-interactive environments, such as CI, the command runs Claude against automatically selected pages, prints a summary of passed and failed pages, and exits with code `0` if every test passes or `1` otherwise. + +Generated test files are written to `tests/mint-test/` inside your docs directory. Run reports are saved to `.mintlify/test/`. + +--- + ## `mint format` Format every `.mdx` file in the current directory to Mintlify's canonical style. The command parses each file with the same MDX parser the web editor uses, then rewrites it in place if the canonical output differs. @@ -693,7 +718,6 @@ These commands are available to run but are not yet functional. Running them rec | Command | Description | | --- | --- | | `mint ai` | AI-powered documentation tools. | -| `mint test` | Documentation testing. | | `mint mcp` | MCP server for documentation. | --- diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index 321cb6e4f6..351e648a69 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -59,7 +59,7 @@ Mentions work on private pages for members who already have access. Each reply c ## Real-time editing -When multiple people open the same page on the same branch, they edit together. Each person's cursor and edits are visible to everyone, with avatars in the toolbar. +When multiple people open the same page on the same branch, they edit together, in both visual and source mode. Each person's cursor and edits are visible to everyone, with avatars in the toolbar. - Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts. - Undo only affects your own edits. diff --git a/editor/pages.mdx b/editor/pages.mdx index 0f74d15b6b..9f53bb5aa2 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -14,7 +14,7 @@ The editor workspace is split into two tabs: **Home** and **Publishing**. **Publishing** is your published site. It shows the navigation your visitors see, along with your site settings. {/* vale Mintlify.OxfordComma = NO */} -Home hides some files by default, including `docs.json`, files and folders whose names start with a dot, files with no extension, all-caps Markdown files like `README.md`, and `.css`, `.js`, `.jsx`, `.mjs`, `.cjs`, and `.pdf` files. To see all files, turn on [Show all files](/editor/settings) or press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows). +Home lists only Markdown pages (`.md` and `.mdx` files) by default. It hides every other file type, such as images, code, spec and data files, PDFs, and `docs.json`, along with dotfiles and all-caps Markdown files like `README.md`. To see all files, turn on [Show all files](/editor/settings) or press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows). {/* vale Mintlify.OxfordComma = YES */} ## Create a page diff --git a/editor/settings.mdx b/editor/settings.mdx index 9fb40a9dd3..15d11e7635 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -19,7 +19,7 @@ Appearance settings are personal preferences. They change the editor only for yo - **Fit editor to full width**: Stretch the editing canvas edge-to-edge instead of the default 768px column. - **Show breadcrumbs**: Show the page's location in the site navigation above the editing canvas. - **Open live preview in new tab**: Open the rendered page in a new browser tab when you preview, instead of the split-pane preview. -- **Show all files**: Show every file in the sidebar, including dotfiles, code, PDFs, and other files hidden by default. You can also press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows) to toggle. +- **Show all files**: The sidebar lists only Markdown pages by default. Turn this on to also show images, spec and data files, code, PDFs, and dotfiles. You can also press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows) to toggle. ## PR instructions diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index a4595f5a6b..db9ebab5c0 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -705,6 +705,33 @@ La puntuación general utiliza puntuación ponderada, por lo que las verificacio --- +
+ ## `mint test` +
+ +Prueba los ejemplos de código de tu documentación con un agente de codificación local. Requiere autenticación con `mint login`. + +```bash +mint test +``` + +Ejecuta el comando desde tu directorio de documentación. Analiza tus páginas en busca de bloques de código delimitados, verifica qué páginas contienen ejemplos que se pueden probar, pide a un agente de codificación que genere pruebas para cada página, ejecuta las pruebas generadas e informa qué páginas pasan o fallan. + +`mint test` ejecuta los agentes de codificación a través de sus SDK, que se instalan por separado: + +| Agente | Instalación | +| --- | --- | +| Claude (predeterminado) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | +| Codex | `npm install @openai/codex-sdk` | + +En terminales interactivas, el comando abre una interfaz guiada donde seleccionas un agente de codificación y las páginas a probar, observas el progreso en vivo y revisas los resultados, incluidas vistas previas de los archivos de prueba generados. Si una ejecución anterior se interrumpió, puedes reanudarla, y las ejecuciones anteriores se guardan para que puedas volver a consultar sus informes. + +En entornos no interactivos, como CI, el comando ejecuta Claude sobre páginas seleccionadas automáticamente, imprime un resumen de las páginas que pasaron y fallaron, y termina con el código `0` si todas las pruebas pasan o `1` en caso contrario. + +Los archivos de prueba generados se escriben en `tests/mint-test/` dentro de tu directorio de documentación. Los informes de cada ejecución se guardan en `.mintlify/test/`. + +--- +
## `mint format`
@@ -777,7 +804,6 @@ Estos comandos están disponibles para ejecutar pero aún no son funcionales. Ej | Comando | Descripción | | --- | --- | | `mint ai` | Herramientas de documentación con IA. | -| `mint test` | Pruebas de documentación. | | `mint mcp` | Servidor MCP para documentación. | --- diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index 7b8fad215e..7cba5fed30 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -75,7 +75,7 @@ Las menciones funcionan en páginas privadas para los miembros que ya tienen acc -Cuando varias personas abren la misma página en la misma branch, editan conjuntamente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas. +Cuando varias personas abren la misma página en la misma branch, editan conjuntamente, tanto en modo visual como en modo fuente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas. - Los cambios de todos los colaboradores se combinan automáticamente. Que dos personas editen la misma sección no genera conflictos. - Deshacer solo afecta a sus propias ediciones. diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index a202244d2a..1a8d9a6802 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -17,7 +17,7 @@ El espacio de trabajo del editor se divide en dos pestañas: **Home** y **Publis **Publishing** es su sitio publicado. Muestra la navegación que ven sus visitantes, junto con la configuración de su sitio. -Home oculta algunos archivos de forma predeterminada, entre ellos `docs.json`, los archivos y carpetas cuyo nombre empieza por un punto, los archivos sin extensión, los archivos Markdown en mayúsculas como `README.md` y los archivos `.css`, `.js`, `.jsx`, `.mjs`, `.cjs` y `.pdf`. Para ver todos los archivos, active [Show all files](/es/editor/settings#appearance) o presione Cmd + Shift + . (macOS) o Ctrl + Shift + . (Windows). +Home muestra de forma predeterminada solo las páginas Markdown (archivos `.md` y `.mdx`). Oculta todos los demás tipos de archivo, como imágenes, código, archivos de especificación y de datos, PDF y `docs.json`, además de los dotfiles y los archivos Markdown en mayúsculas como `README.md`. Para ver todos los archivos, active [Show all files](/es/editor/settings#appearance) o presione Cmd + Shift + . (macOS) o Ctrl + Shift + . (Windows).
diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index 2e16ae1bb7..76f4a238cb 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -23,7 +23,7 @@ Los ajustes de apariencia son preferencias personales. Cambian el editor solo pa - **Fit editor to full width**: Extiende el lienzo de edición de borde a borde en lugar de usar la columna predeterminada de 768px. - **Show breadcrumbs**: Muestra la ubicación de la página en la navegación del sitio encima del lienzo de edición. - **Open live preview in new tab**: Abre la página representada en una pestaña nueva del navegador al previsualizar, en lugar de la vista previa en panel dividido. -- **Show all files**: Muestra todos los archivos en la barra lateral, incluidos los dotfiles, el código, los PDF y otros archivos ocultos de forma predeterminada. También puede pulsar Cmd + Shift + . (macOS) o Ctrl + Shift + . (Windows) para alternarlo. +- **Show all files**: La barra lateral muestra solo las páginas Markdown de forma predeterminada. Active esta opción para mostrar también imágenes, archivos de especificación y de datos, código, PDF y dotfiles. También puede pulsar Cmd + Shift + . (macOS) o Ctrl + Shift + . (Windows) para alternarlo.
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index ce7d9d26fc..6ed6b38748 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -707,6 +707,33 @@ Le score global utilise une notation pondérée, de sorte que les vérifications --- +
+ ## `mint test` +
+ +Testez les exemples de code de votre documentation avec un agent de codage local. Nécessite une authentification avec `mint login`. + +```bash +mint test +``` + +Exécutez la commande depuis votre répertoire de documentation. Elle analyse vos pages à la recherche de blocs de code délimités, vérifie quelles pages contiennent des exemples testables, demande à un agent de codage de générer des tests pour chaque page, exécute les tests générés et indique quelles pages réussissent ou échouent. + +`mint test` exécute les agents de codage via leurs SDK, que vous installez séparément : + +| Agent | Installation | +| --- | --- | +| Claude (par défaut) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | +| Codex | `npm install @openai/codex-sdk` | + +Dans les terminaux interactifs, la commande ouvre une interface guidée où vous sélectionnez un agent de codage et les pages à tester, suivez la progression en direct et examinez les résultats, y compris des aperçus des fichiers de test générés. Si une exécution précédente a été interrompue, vous pouvez la reprendre, et les exécutions passées sont enregistrées pour que vous puissiez consulter à nouveau leurs rapports. + +Dans les environnements non interactifs, comme la CI, la commande exécute Claude sur des pages sélectionnées automatiquement, affiche un résumé des pages réussies et échouées, et se termine avec le code `0` si tous les tests réussissent ou `1` sinon. + +Les fichiers de test générés sont écrits dans `tests/mint-test/` à l'intérieur de votre répertoire de documentation. Les rapports d'exécution sont enregistrés dans `.mintlify/test/`. + +--- +
## `mint format`
@@ -779,7 +806,6 @@ Ces commandes sont disponibles mais ne sont pas encore fonctionnelles. Les exéc | Commande | Description | | --- | --- | | `mint ai` | Outils de documentation assistés par IA. | -| `mint test` | Tests de documentation. | | `mint mcp` | Serveur MCP pour la documentation. | --- diff --git a/fr/editor/collaborate.mdx b/fr/editor/collaborate.mdx index a5d4b98240..559d8412e1 100644 --- a/fr/editor/collaborate.mdx +++ b/fr/editor/collaborate.mdx @@ -75,7 +75,7 @@ Les mentions fonctionnent sur les pages privées pour les membres qui y ont déj
-Lorsque plusieurs personnes ouvrent la même page sur la même branch, elles la modifient ensemble. Le curseur et les modifications de chacun sont visibles par tous, avec des avatars dans la barre d'outils. +Lorsque plusieurs personnes ouvrent la même page sur la même branch, elles la modifient ensemble, en mode visuel comme en mode source. Le curseur et les modifications de chacun sont visibles par tous, avec des avatars dans la barre d'outils. - Les modifications de tous les collaborateurs fusionnent automatiquement. Deux personnes qui modifient la même section ne créent pas de conflit. - L'annulation n'affecte que vos propres modifications. diff --git a/fr/editor/pages.mdx b/fr/editor/pages.mdx index 688089b750..c91cd1f548 100644 --- a/fr/editor/pages.mdx +++ b/fr/editor/pages.mdx @@ -17,7 +17,7 @@ L'espace de travail de l'éditeur est divisé en deux onglets : **Home** et **Pu **Publishing** est votre site publié. Il affiche la navigation que voient vos visiteurs, ainsi que les paramètres de votre site. -Home masque certains fichiers par défaut, notamment `docs.json`, les fichiers et dossiers dont le nom commence par un point, les fichiers sans extension, les fichiers Markdown en majuscules comme `README.md`, ainsi que les fichiers `.css`, `.js`, `.jsx`, `.mjs`, `.cjs` et `.pdf`. Pour afficher tous les fichiers, activez [Show all files](/fr/editor/settings#appearance) ou appuyez sur Cmd + Shift + . (macOS) ou Ctrl + Shift + . (Windows). +Home n'affiche par défaut que les pages Markdown (fichiers `.md` et `.mdx`). Il masque tous les autres types de fichiers, comme les images, le code, les fichiers de spécification et de données, les PDF et `docs.json`, ainsi que les dotfiles et les fichiers Markdown en majuscules comme `README.md`. Pour afficher tous les fichiers, activez [Show all files](/fr/editor/settings#appearance) ou appuyez sur Cmd + Shift + . (macOS) ou Ctrl + Shift + . (Windows).
diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index 1d25c1986c..9cf285e40e 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -23,7 +23,7 @@ Les paramètres d'apparence sont des préférences personnelles. Ils ne modifien - **Fit editor to full width** : Étend la zone d'édition d'un bord à l'autre au lieu de la colonne de 768px par défaut. - **Show breadcrumbs** : Affiche l'emplacement de la page dans la navigation du site au-dessus de la zone d'édition. - **Open live preview in new tab** : Ouvre la page rendue dans un nouvel onglet du navigateur lors de la prévisualisation, au lieu de l'aperçu en volet partagé. -- **Show all files** : Affiche tous les fichiers dans la barre latérale, y compris les dotfiles, le code, les PDF et les autres fichiers masqués par défaut. Vous pouvez aussi appuyer sur Cmd + Shift + . (macOS) ou Ctrl + Shift + . (Windows) pour basculer l'affichage. +- **Show all files** : La barre latérale n'affiche par défaut que les pages Markdown. Activez cette option pour afficher aussi les images, les fichiers de spécification et de données, le code, les PDF et les dotfiles. Vous pouvez aussi appuyer sur Cmd + Shift + . (macOS) ou Ctrl + Shift + . (Windows) pour basculer l'affichage.
diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index afdd983fb7..d3435d1152 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -707,6 +707,33 @@ mint score docs.example.com --- +
+ ## `mint test` +
+ +使用本地编码代理测试文档中的代码示例。需要先通过 `mint login` 进行身份验证。 + +```bash +mint test +``` + +在文档目录中运行该命令。它会扫描页面中的围栏代码块,检查哪些页面包含可测试的示例,让编码代理为每个页面生成测试,运行生成的测试,并报告哪些页面通过或失败。 + +`mint test` 通过编码代理的 SDK 运行代理,这些 SDK 需要单独安装: + +| 代理 | 安装方式 | +| --- | --- | +| Claude(默认) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | +| Codex | `npm install @openai/codex-sdk` | + +在交互式终端中,该命令会打开一个引导式界面,你可以在其中选择编码代理和要测试的页面,实时查看进度,并审查结果,包括预览生成的测试文件。如果之前的运行被中断,可以恢复它;历史运行也会被保存,方便你随时回看报告。 + +在非交互式环境(例如 CI)中,该命令使用 Claude 对自动选择的页面运行测试,打印通过和失败页面的摘要,并在所有测试通过时以退出码 `0` 结束,否则以 `1` 结束。 + +生成的测试文件写入文档目录下的 `tests/mint-test/`。运行报告保存在 `.mintlify/test/` 中。 + +--- +
## `mint format`
@@ -779,7 +806,6 @@ mint version | 命令 | 描述 | | --- | --- | | `mint ai` | AI 驱动的文档工具。 | -| `mint test` | 文档测试。 | | `mint mcp` | 文档 MCP 服务器。 | --- diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index 5b41df344a..ed93430c64 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -75,7 +75,7 @@ Editors 和 admins 可以接受或拒绝任何建议,viewers 不能。
-当多人在同一分支上打开同一页面时,他们会协同编辑。每个人的光标和编辑对所有人可见,工具栏中会显示头像。 +当多人在同一分支上打开同一页面时,他们会协同编辑,可视化模式和源码模式均支持。每个人的光标和编辑对所有人可见,工具栏中会显示头像。 - 所有协作者的更改会自动合并。两人编辑同一部分不会产生冲突。 - 撤销只影响你自己的编辑。 diff --git a/zh/editor/pages.mdx b/zh/editor/pages.mdx index 4eeaa36640..f9b267efb0 100644 --- a/zh/editor/pages.mdx +++ b/zh/editor/pages.mdx @@ -17,7 +17,7 @@ keywords: ["editor", "content", "pages", "navigation", "version history", "media **Publishing** 是你已发布的站点,显示访问者看到的导航以及站点设置。 -Home 默认会隐藏部分文件,包括 `docs.json`、名称以点开头的文件和文件夹、没有扩展名的文件、像 `README.md` 这样的全大写 Markdown 文件,以及 `.css`、`.js`、`.jsx`、`.mjs`、`.cjs` 和 `.pdf` 文件。若要查看全部文件,请启用 [Show all files](/zh/editor/settings#appearance),或按 Cmd + Shift + .(macOS)或 Ctrl + Shift + .(Windows)。 +Home 默认只显示 Markdown 页面(`.md` 和 `.mdx` 文件)。其他所有文件类型都会被隐藏,例如图片、代码、规范和数据文件、PDF 以及 `docs.json`,还有 dotfile 和像 `README.md` 这样的全大写 Markdown 文件。若要查看全部文件,请启用 [Show all files](/zh/editor/settings#appearance),或按 Cmd + Shift + .(macOS)或 Ctrl + Shift + .(Windows)。
diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 2d8e34564d..bcd451a2c5 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -23,7 +23,7 @@ keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull reque - **Fit editor to full width**:让编辑区域横向铺满,而不使用默认的 768px 栏宽。 - **Show breadcrumbs**:在编辑区域上方显示该页面在站点导航中的位置。 - **Open live preview in new tab**:预览时在新的浏览器标签页中打开渲染后的页面,而不使用分栏预览。 -- **Show all files**:在侧边栏中显示全部文件,包括 dotfile、代码、PDF,以及其他默认隐藏的文件。你也可以按 Cmd + Shift + .(macOS)或 Ctrl + Shift + .(Windows)进行切换。 +- **Show all files**:侧边栏默认只列出 Markdown 页面。启用此选项可同时显示图片、规范和数据文件、代码、PDF 和 dotfile。你也可以按 Cmd + Shift + .(macOS)或 Ctrl + Shift + .(Windows)进行切换。
From eecf469de7db4089911f2c7f36281b78b4d1a295 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 3 Sep 2026 18:19:17 +0000 Subject: [PATCH 2/2] docs: shorten long sentences in mint test docs and fix zh CLI description length --- cli/commands.mdx | 6 +++--- es/cli/commands.mdx | 6 +++--- fr/cli/commands.mdx | 6 +++--- zh/cli/commands.mdx | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/cli/commands.mdx b/cli/commands.mdx index 99a92f59f5..03c2969d0d 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -639,7 +639,7 @@ Test the code examples in your documentation with a local coding agent. Requires mint test ``` -Run the command from your docs directory. It scans your pages for fenced code blocks, checks which pages contain testable examples, asks a coding agent to generate tests for each page, runs the generated tests, and reports which pages pass or fail. +Run the command from your docs directory. It scans your pages for fenced code blocks and checks which pages contain testable examples. A coding agent generates tests for each page. The command runs the generated tests and reports which pages pass or fail. `mint test` runs coding agents through their SDKs, which you install separately: @@ -648,9 +648,9 @@ Run the command from your docs directory. It scans your pages for fenced code bl | Claude (default) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | | Codex | `npm install @openai/codex-sdk` | -In interactive terminals, the command opens a guided interface where you select a coding agent and the pages to test, watch live progress, and review results, including previews of the generated test files. If a previous run was interrupted, you can resume it, and past runs are saved so you can revisit their reports. +In interactive terminals, the command opens a guided interface where you select a coding agent and the pages to test. You can watch live progress and review results, including previews of the generated test files. You can resume an interrupted run, and past runs are saved so you can revisit their reports. -In non-interactive environments, such as CI, the command runs Claude against automatically selected pages, prints a summary of passed and failed pages, and exits with code `0` if every test passes or `1` otherwise. +In non-interactive environments, such as CI, the command runs Claude against automatically selected pages and prints a summary of passed and failed pages. It exits with code `0` if every test passes or `1` otherwise. Generated test files are written to `tests/mint-test/` inside your docs directory. Run reports are saved to `.mintlify/test/`. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index db9ebab5c0..a2ba6862e5 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -715,7 +715,7 @@ Prueba los ejemplos de código de tu documentación con un agente de codificaci mint test ``` -Ejecuta el comando desde tu directorio de documentación. Analiza tus páginas en busca de bloques de código delimitados, verifica qué páginas contienen ejemplos que se pueden probar, pide a un agente de codificación que genere pruebas para cada página, ejecuta las pruebas generadas e informa qué páginas pasan o fallan. +Ejecuta el comando desde tu directorio de documentación. Analiza tus páginas en busca de bloques de código delimitados y verifica qué páginas contienen ejemplos que se pueden probar. Un agente de codificación genera pruebas para cada página. El comando ejecuta las pruebas generadas e informa qué páginas pasan o fallan. `mint test` ejecuta los agentes de codificación a través de sus SDK, que se instalan por separado: @@ -724,9 +724,9 @@ Ejecuta el comando desde tu directorio de documentación. Analiza tus páginas e | Claude (predeterminado) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | | Codex | `npm install @openai/codex-sdk` | -En terminales interactivas, el comando abre una interfaz guiada donde seleccionas un agente de codificación y las páginas a probar, observas el progreso en vivo y revisas los resultados, incluidas vistas previas de los archivos de prueba generados. Si una ejecución anterior se interrumpió, puedes reanudarla, y las ejecuciones anteriores se guardan para que puedas volver a consultar sus informes. +En terminales interactivas, el comando abre una interfaz guiada donde seleccionas un agente de codificación y las páginas a probar. Puedes observar el progreso en vivo y revisar los resultados, incluidas vistas previas de los archivos de prueba generados. Puedes reanudar una ejecución interrumpida, y las ejecuciones anteriores se guardan para que puedas volver a consultar sus informes. -En entornos no interactivos, como CI, el comando ejecuta Claude sobre páginas seleccionadas automáticamente, imprime un resumen de las páginas que pasaron y fallaron, y termina con el código `0` si todas las pruebas pasan o `1` en caso contrario. +En entornos no interactivos, como CI, el comando ejecuta Claude sobre páginas seleccionadas automáticamente e imprime un resumen de las páginas que pasaron y fallaron. Termina con el código `0` si todas las pruebas pasan o `1` en caso contrario. Los archivos de prueba generados se escriben en `tests/mint-test/` dentro de tu directorio de documentación. Los informes de cada ejecución se guardan en `.mintlify/test/`. diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 6ed6b38748..d78f4ef602 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -717,7 +717,7 @@ Testez les exemples de code de votre documentation avec un agent de codage local mint test ``` -Exécutez la commande depuis votre répertoire de documentation. Elle analyse vos pages à la recherche de blocs de code délimités, vérifie quelles pages contiennent des exemples testables, demande à un agent de codage de générer des tests pour chaque page, exécute les tests générés et indique quelles pages réussissent ou échouent. +Exécutez la commande depuis votre répertoire de documentation. Elle analyse vos pages à la recherche de blocs de code délimités et vérifie quelles pages contiennent des exemples testables. Un agent de codage génère des tests pour chaque page. La commande exécute les tests générés et indique quelles pages réussissent ou échouent. `mint test` exécute les agents de codage via leurs SDK, que vous installez séparément : @@ -726,9 +726,9 @@ Exécutez la commande depuis votre répertoire de documentation. Elle analyse vo | Claude (par défaut) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | | Codex | `npm install @openai/codex-sdk` | -Dans les terminaux interactifs, la commande ouvre une interface guidée où vous sélectionnez un agent de codage et les pages à tester, suivez la progression en direct et examinez les résultats, y compris des aperçus des fichiers de test générés. Si une exécution précédente a été interrompue, vous pouvez la reprendre, et les exécutions passées sont enregistrées pour que vous puissiez consulter à nouveau leurs rapports. +Dans les terminaux interactifs, la commande ouvre une interface guidée où vous sélectionnez un agent de codage et les pages à tester. Vous pouvez suivre la progression en direct et examiner les résultats, y compris des aperçus des fichiers de test générés. Vous pouvez reprendre une exécution interrompue, et les exécutions passées sont enregistrées pour que vous puissiez consulter à nouveau leurs rapports. -Dans les environnements non interactifs, comme la CI, la commande exécute Claude sur des pages sélectionnées automatiquement, affiche un résumé des pages réussies et échouées, et se termine avec le code `0` si tous les tests réussissent ou `1` sinon. +Dans les environnements non interactifs, comme la CI, la commande exécute Claude sur des pages sélectionnées automatiquement et affiche un résumé des pages réussies et échouées. Elle se termine avec le code `0` si tous les tests réussissent ou `1` sinon. Les fichiers de test générés sont écrits dans `tests/mint-test/` à l'intérieur de votre répertoire de documentation. Les rapports d'exécution sont enregistrés dans `.mintlify/test/`. diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index d3435d1152..3509e938f4 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify CLI 命令参考" sidebarTitle: "命令参考" -description: "Mintlify CLI 所有命令和选项的完整参考,涵盖 mint index、mint dev、mint validate 和 mint broken-links,并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流,帮助你完成日常文档开发以及部署前检查。" +description: "Mintlify CLI 命令与选项的完整参考,涵盖 mint dev、mint validate、mint broken-links 等命令的用法。" keywords: ["CLI", "mint", "命令", "选项", "参考"] boost: 3 --- @@ -717,7 +717,7 @@ mint score docs.example.com mint test ``` -在文档目录中运行该命令。它会扫描页面中的围栏代码块,检查哪些页面包含可测试的示例,让编码代理为每个页面生成测试,运行生成的测试,并报告哪些页面通过或失败。 +在文档目录中运行该命令。它会扫描页面中的围栏代码块,并检查哪些页面包含可测试的示例。编码代理为每个页面生成测试。该命令运行生成的测试,并报告哪些页面通过或失败。 `mint test` 通过编码代理的 SDK 运行代理,这些 SDK 需要单独安装: @@ -726,9 +726,9 @@ mint test | Claude(默认) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` | | Codex | `npm install @openai/codex-sdk` | -在交互式终端中,该命令会打开一个引导式界面,你可以在其中选择编码代理和要测试的页面,实时查看进度,并审查结果,包括预览生成的测试文件。如果之前的运行被中断,可以恢复它;历史运行也会被保存,方便你随时回看报告。 +在交互式终端中,该命令会打开一个引导式界面,你可以在其中选择编码代理和要测试的页面。你可以实时查看进度并审查结果,包括预览生成的测试文件。你可以恢复被中断的运行;历史运行也会被保存,方便你随时回看报告。 -在非交互式环境(例如 CI)中,该命令使用 Claude 对自动选择的页面运行测试,打印通过和失败页面的摘要,并在所有测试通过时以退出码 `0` 结束,否则以 `1` 结束。 +在非交互式环境(例如 CI)中,该命令使用 Claude 对自动选择的页面运行测试,并打印通过和失败页面的摘要。所有测试通过时以退出码 `0` 结束,否则以 `1` 结束。 生成的测试文件写入文档目录下的 `tests/mint-test/`。运行报告保存在 `.mintlify/test/` 中。