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 --- +