diff --git a/admin-openapi.json b/admin-openapi.json index 35b8d15754..b4d2f95aa3 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -16,84 +16,6 @@ } ], "paths": { - "/v1/deslop/{projectId}": { - "post": { - "summary": "Detect AI-sounding prose in a page", - "description": "Analyzes a page for AI-generated prose and returns flagged passages with suggested rewrites. Consumes one AI credit per checked page. Skips pages under 50 words. Limited to 30 requests per minute per client IP address.", - "parameters": [ - { - "name": "projectId", - "in": "path", - "required": true, - "schema": { "type": "string" }, - "description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": ["path", "content"], - "properties": { - "path": { - "type": "string", - "minLength": 1, - "description": "Repo-relative path of the page, used for reporting only." - }, - "content": { - "type": "string", - "maxLength": 1000000, - "description": "The raw MDX or Markdown content of the page to check." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The page was checked, or skipped because it was too short.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/DeslopResult" } } - } - }, - "400": { - "description": "Invalid request body.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "402": { - "description": "Insufficient AI credits.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "429": { - "description": "Rate limit exceeded.", - "content": { - "text/plain": { - "schema": { - "type": "string", - "example": "Too many requests, please try again later." - } - } - } - }, - "503": { - "description": "Detection is temporarily unavailable. No credit is charged.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "500": { - "description": "An unexpected error occurred while processing the page." - } - } - } - }, "/v1/agent/{projectId}/job": { "post": { "summary": "Create agent job (v1)", @@ -640,63 +562,6 @@ }, "components": { "schemas": { - "DeslopResult": { - "type": "object", - "required": ["path", "skipped", "creditsCharged"], - "properties": { - "path": { "type": "string", "description": "The path from the request." }, - "skipped": { - "type": "string", - "nullable": true, - "enum": ["too_short", null], - "description": "Reason the page was skipped, or null when the page was checked. `too_short` means the page had fewer than 50 words of prose and was not charged." - }, - "predictionShort": { - "type": "string", - "enum": ["AI", "AI-Assisted", "Human", "Mixed"], - "description": "Overall verdict for the page. Present only when the page was checked." - }, - "fractionAi": { "type": "number", "description": "Fraction of the page detected as AI-generated (0-1)." }, - "fractionAiAssisted": { "type": "number", "description": "Fraction detected as AI-assisted (0-1)." }, - "fractionHuman": { "type": "number", "description": "Fraction detected as human-written (0-1)." }, - "windows": { - "type": "array", - "description": "Flagged (non-human) passages. Present only when the page was checked.", - "items": { "$ref": "#/components/schemas/DeslopWindow" } - }, - "creditsCharged": { "type": "integer", "description": "AI credits charged for this request (0 when skipped)." } - } - }, - "DeslopWindow": { - "type": "object", - "required": ["text", "label", "aiAssistanceScore", "startLine", "endLine"], - "properties": { - "text": { "type": "string", "description": "The flagged passage text." }, - "label": { "type": "string", "description": "Detection label for the passage, for example `AI-Generated`." }, - "aiAssistanceScore": { "type": "number", "description": "AI-assistance score for the passage (0-1)." }, - "confidence": { - "description": "Detection confidence, returned as either a label such as `High` or a numeric score.", - "oneOf": [ - { "type": "string" }, - { "type": "number" } - ] - }, - "startLine": { "type": "integer", "description": "1-based start line of the passage in the original content." }, - "endLine": { "type": "integer", "description": "1-based end line of the passage in the original content." }, - "rewrites": { - "type": "array", - "description": "Suggested human rewrites of the passage.", - "items": { - "type": "object", - "required": ["text", "rationale"], - "properties": { - "text": { "type": "string", "description": "The rewritten passage." }, - "rationale": { "type": "string", "description": "Why the rewrite reads more human." } - } - } - } - } - }, "AgentJob": { "type": "object", "properties": { diff --git a/agent-context/context/skills/mintlify/SKILL.md b/agent-context/context/skills/mintlify/SKILL.md index ebef19a2c7..fe6a94643b 100644 --- a/agent-context/context/skills/mintlify/SKILL.md +++ b/agent-context/context/skills/mintlify/SKILL.md @@ -217,7 +217,7 @@ Use `` to arrange cards (or other content) in a grid. `cols` accepts 1- ## CLI commands -Install with `npm i -g mint`. Key commands: `mint dev` (local preview), `mint validate`, `mint broken-links`, `mint a11y`, `mint score`, `mint automations`, `mint deslop`, `mint new`, `mint signup`, `mint index` (install the Mintlify Index MCP server in supported coding agents). Read `reference/cli.md` for full flags and subcommands. +Install with `npm i -g mint`. Key commands: `mint dev` (local preview), `mint validate`, `mint broken-links`, `mint a11y`, `mint score`, `mint automations`, `mint new`, `mint signup`, `mint index` (install the Mintlify Index MCP server in supported coding agents). Read `reference/cli.md` for full flags and subcommands. ## Writing standards diff --git a/agent-context/context/skills/mintlify/reference/cli.md b/agent-context/context/skills/mintlify/reference/cli.md index 870e92b1eb..9bb95a0e81 100644 --- a/agent-context/context/skills/mintlify/reference/cli.md +++ b/agent-context/context/skills/mintlify/reference/cli.md @@ -25,7 +25,6 @@ Available on all commands. - `mint broken-links` — Check for broken internal links. `--files ` limits the check to specific files or globs. `--check-anchors` validates `#` anchors. `--check-external` checks external URLs. `--check-redirects` checks that redirect destinations in `docs.json` resolve. `--check-snippets` checks links inside `` components. - `mint a11y` — Accessibility checks (alt text, color contrast). `--skip-contrast` or `--skip-alt-text` to narrow scope. - `mint score [url]` — Score a docs site's AI/agent readiness. Checks llms.txt, MCP discoverability, robots.txt, sitemap, structured data, response latency, and more. Requires `mint login`. Defaults to your configured subdomain. `--format` accepts `table` (default), `plain`, or `json`. -- `mint deslop [files...]` — Check pages for AI-sounding prose and get rewrite suggestions. Requires `mint login`. Without `files`, checks the `.md`/`.mdx` pages changed in your working tree (Git diff plus untracked files). Flags: `--format` (`table`/`plain`/`json`), `--subdomain`, `--threshold` (0-1, default 0.5), `--fix-whitespace` (normalizes trailing spaces, blank-line runs, and invisible Unicode outside code blocks/frontmatter). - `mint format` — Format every `.mdx` file in the current directory and its subdirectories in place. Respects `.gitignore` and Mintlify ignore rules. Commit or stash changes first so you can review the rewrite. ## Authentication diff --git a/api/admin/deslop.mdx b/api/admin/deslop.mdx deleted file mode 100644 index 4903358ff8..0000000000 --- a/api/admin/deslop.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Detect AI-sounding prose" -openapi: /admin-openapi.json POST /v1/deslop/{projectId} -keywords: ["deslop", "AI detection", "slop", "prose", "content quality"] ---- - -This endpoint analyzes a documentation page for AI-generated prose and returns flagged passages with suggested human rewrites. - -Authenticate with an [admin API key](/api/introduction#admin-api-key). - -## Credits - -- Consumes 1 AI credit per checked page. -- The endpoint skips pages under 50 words and does not charge for them. The response returns `skipped: "too_short"` with `creditsCharged: 0`. -- If detection is temporarily unavailable, the endpoint returns `503` and doesn't consume a credit. -- The endpoint accepts up to 30 requests per minute per client IP address. - -## Response - -Checked pages return a verdict (`predictionShort`), AI and human fractions, and a `windows` array of flagged passages. Each window includes a line range and can include one to three suggested rewrites. - -## Usage - -```bash -curl -X POST https://api.mintlify.com/v1/deslop/{projectId} \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{ - "path": "guides/quickstart.mdx", - "content": "# Quickstart\n\nWelcome to our comprehensive documentation..." - }' -``` diff --git a/api/introduction.mdx b/api/introduction.mdx index b208997f03..f7f5b4c261 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -19,7 +19,6 @@ The Mintlify REST (Representational State Transfer) API enables you to programma - [Get update status](/api/update/status): Get the status of an update and other details about your docs. - [Trigger preview deployment](/api/preview/trigger): Create or update a preview deployment for a specific branch. - [Trigger automation](/api/automations/trigger): Run a scheduled automation on demand. -- [Detect AI-sounding prose](/api/admin/deslop): Analyze a page for AI-generated prose and get suggested human rewrites. - [Create agent job](/api/agent/v2/create-agent-job): Create an agent job to automatically edit your documentation. - [Get agent job](/api/agent/v2/get-agent-job): Retrieve the details and status of a specific agent job. - [Send follow-up message](/api/agent/v2/send-message): Send a follow-up message to an existing agent job. @@ -69,7 +68,6 @@ Use the admin API key for deployment, triggering the agent, and analytics endpoi - [Get update status](/api/update/status) - [Trigger preview deployment](/api/preview/trigger) - [Trigger automation](/api/automations/trigger) -- [Detect AI-sounding prose](/api/admin/deslop) - [Create agent job](/api/agent/v2/create-agent-job) - [Get agent job](/api/agent/v2/get-agent-job) - [Send follow-up message](/api/agent/v2/send-message) diff --git a/cli/commands.mdx b/cli/commands.mdx index 4ef56a09f9..2c5623e822 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -497,47 +497,6 @@ The overall score uses weighted scoring, so higher-impact checks contribute more --- -## `mint deslop` - -Check documentation pages for AI-sounding prose and get rewrite suggestions. Requires authentication with `mint login`. - -```bash -mint deslop [files...] [flags] -``` - -| Argument | Description | -| --- | --- | -| `files` | Optional. Paths or globs to check. If omitted, the command checks the `.md` and `.mdx` pages that changed in your working tree (Git diff plus untracked files). | - -| Flag | Description | -| --- | --- | -| `--format` | Output format: `table` (default, colored), `plain` (pipeable), or `json`. | -| `--subdomain` | Documentation subdomain to check against. Defaults to your configured subdomain. | -| `--threshold` | Fail a page when the sum of its AI-generated and AI-assisted fractions is greater than this value, from `0` to `1`. Defaults to `0.5`. | -| `--fix-whitespace` | Normalize prose whitespace in the checked files (trailing spaces, blank-line runs, and invisible Unicode characters). Skips code blocks and frontmatter. | - -For each flagged page, the command reports the AI-written fraction, the specific passages that read as AI-generated with their line numbers, and suggested human-style rewrites. - -Each checked page consumes one AI credit. The command skips pages under 50 words and does not charge for them. If any page is at or above the threshold, or if a check returns an error, the command exits with code `1`. If every page is clean, the command exits with code `0`. This lets you run the command in a rewrite loop or in CI. - -### Examples - -```bash -# Check pages changed in your working tree -mint deslop - -# Check a specific page -mint deslop docs/guide.mdx - -# Check every MDX page and emit JSON for scripting -mint deslop "docs/**/*.mdx" --format json - -# Also clean up whitespace in the checked files -mint deslop docs/guide.mdx --fix-whitespace -``` - ---- - ## `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. diff --git a/cli/index.mdx b/cli/index.mdx index f75a03f42a..e3923205fa 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -36,9 +36,6 @@ Run `mint broken-links` to find broken links, `mint a11y` to check accessibility ### Check agent readiness Run `mint score` to evaluate how well agents can navigate a documentation site. With no arguments, the command scores your configured subdomain. Pass a URL to score any other site. The command displays an overall readiness score and individual check results. -### Detect AI-sounding prose -Run `mint deslop` to check pages for AI-generated prose and get human-style rewrite suggestions. With no arguments, the command checks the pages you have changed. It flags the specific passages that read as AI-generated so you can revise them. - ### Format MDX files Run `mint format` to rewrite the MDX files in your project to Mintlify's canonical style. The command walks every subdirectory and reformats files in place. diff --git a/docs.json b/docs.json index 626d3f3dd5..15029ca54c 100644 --- a/docs.json +++ b/docs.json @@ -395,8 +395,7 @@ "api/update/trigger", "api/update/status", "api/preview/trigger", - "api/automations/trigger", - "api/admin/deslop" + "api/automations/trigger" ] }, { diff --git a/es.json b/es.json index e0d44a0d3b..e5370bde23 100644 --- a/es.json +++ b/es.json @@ -373,8 +373,7 @@ "es/api/update/trigger", "es/api/update/status", "es/api/preview/trigger", - "es/api/automations/trigger", - "es/api/admin/deslop" + "es/api/automations/trigger" ] }, { diff --git a/es/admin-openapi.json b/es/admin-openapi.json index a4cb0ba166..993c9242d0 100644 --- a/es/admin-openapi.json +++ b/es/admin-openapi.json @@ -16,84 +16,6 @@ } ], "paths": { - "/v1/deslop/{projectId}": { - "post": { - "summary": "Detectar prosa que suena a IA en una página", - "description": "Analiza una página en busca de prosa generada por IA y devuelve los pasajes marcados con reescrituras sugeridas. Consume un crédito de IA por página comprobada. Omite las páginas con menos de 50 palabras. Limitado a 30 solicitudes por minuto por dirección IP del cliente.", - "parameters": [ - { - "name": "projectId", - "in": "path", - "required": true, - "schema": { "type": "string" }, - "description": "El ID de tu proyecto. Se puede copiar desde la página de [claves de API](https://app.mintlify.com/settings/organization/api-keys) en tu panel de control." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": ["path", "content"], - "properties": { - "path": { - "type": "string", - "minLength": 1, - "description": "Ruta de la página relativa al repositorio, utilizada solo para informes." - }, - "content": { - "type": "string", - "maxLength": 1000000, - "description": "El contenido MDX o Markdown sin procesar de la página que se va a comprobar." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "La página se comprobó, o se omitió porque era demasiado corta.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/DeslopResult" } } - } - }, - "400": { - "description": "Cuerpo de la solicitud no válido.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "402": { - "description": "Créditos de IA insuficientes.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "429": { - "description": "Se ha superado el límite de tasa.", - "content": { - "text/plain": { - "schema": { - "type": "string", - "example": "Demasiadas solicitudes, inténtalo de nuevo más tarde." - } - } - } - }, - "503": { - "description": "La detección no está disponible temporalmente. No se cobra ningún crédito.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "500": { - "description": "Se produjo un error inesperado al procesar la página." - } - } - } - }, "/v1/agent/{projectId}/job": { "post": { "summary": "Crear trabajo del agente (v1)", @@ -681,63 +603,6 @@ }, "components": { "schemas": { - "DeslopResult": { - "type": "object", - "required": ["path", "skipped", "creditsCharged"], - "properties": { - "path": { "type": "string", "description": "La ruta proveniente de la solicitud." }, - "skipped": { - "type": "string", - "nullable": true, - "enum": ["too_short", null], - "description": "Motivo por el que se omitió la página, o null cuando la página se comprobó. `too_short` significa que la página tenía menos de 50 palabras de prosa y no se cobró." - }, - "predictionShort": { - "type": "string", - "enum": ["AI", "AI-Assisted", "Human", "Mixed"], - "description": "Veredicto general de la página. Presente solo cuando la página se comprobó." - }, - "fractionAi": { "type": "number", "description": "Fracción de la página detectada como generada por IA (0-1)." }, - "fractionAiAssisted": { "type": "number", "description": "Fracción detectada como asistida por IA (0-1)." }, - "fractionHuman": { "type": "number", "description": "Fracción detectada como escrita por humanos (0-1)." }, - "windows": { - "type": "array", - "description": "Pasajes marcados (no humanos). Presente solo cuando la página se comprobó.", - "items": { "$ref": "#/components/schemas/DeslopWindow" } - }, - "creditsCharged": { "type": "integer", "description": "Créditos de IA cobrados por esta solicitud (0 cuando se omite)." } - } - }, - "DeslopWindow": { - "type": "object", - "required": ["text", "label", "aiAssistanceScore", "startLine", "endLine"], - "properties": { - "text": { "type": "string", "description": "El texto del pasaje marcado." }, - "label": { "type": "string", "description": "Etiqueta de detección para el pasaje, por ejemplo `AI-Generated`." }, - "aiAssistanceScore": { "type": "number", "description": "Puntuación de asistencia por IA para el pasaje (0-1)." }, - "confidence": { - "description": "Confianza de la detección, devuelta como una etiqueta como `High` o un valor numérico.", - "oneOf": [ - { "type": "string" }, - { "type": "number" } - ] - }, - "startLine": { "type": "integer", "description": "Línea de inicio del pasaje en el contenido original (índice basado en 1)." }, - "endLine": { "type": "integer", "description": "Línea final del pasaje en el contenido original (índice basado en 1)." }, - "rewrites": { - "type": "array", - "description": "Reescrituras humanas sugeridas del pasaje.", - "items": { - "type": "object", - "required": ["text", "rationale"], - "properties": { - "text": { "type": "string", "description": "El pasaje reescrito." }, - "rationale": { "type": "string", "description": "Por qué la reescritura suena más humana." } - } - } - } - } - }, "AgentJob": { "type": "object", "properties": { diff --git a/es/api/admin/deslop.mdx b/es/api/admin/deslop.mdx deleted file mode 100644 index cb415fd4ab..0000000000 --- a/es/api/admin/deslop.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Detectar prosa que suena a IA" -openapi: /es/admin-openapi.json POST /v1/deslop/{projectId} -keywords: ["deslop", "detección de IA", "slop", "prosa", "calidad del contenido"] ---- - -Este endpoint analiza una página de documentación en busca de prosa generada por IA y devuelve los pasajes marcados con reescrituras humanas sugeridas. - -Autentícate con una [clave de API de administrador](/es/api/introduction#admin-api-key). - -
- ## Créditos -
- -- Consume 1 crédito de IA por página comprobada. -- Las páginas con menos de 50 palabras se omiten y no se cobran. La respuesta devuelve `skipped: "too_short"` con `creditsCharged: 0`. -- Si la detección no está disponible temporalmente, el endpoint devuelve `503` y no se cobra ningún crédito. -- El endpoint acepta hasta 30 solicitudes por minuto por dirección IP del cliente. - -
- ## Respuesta -
- -Las páginas comprobadas devuelven un veredicto (`predictionShort`), fracciones de IA y humana, y un arreglo `windows` de pasajes marcados. Cada window incluye un rango de líneas y puede incluir de una a tres reescrituras sugeridas. - -
- ## Uso -
- -```bash -curl -X POST https://api.mintlify.com/v1/deslop/{projectId} \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{ - "path": "guides/quickstart.mdx", - "content": "# Quickstart\n\nWelcome to our comprehensive documentation..." - }' -``` diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index 1db95a1d18..d245245f85 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -21,7 +21,6 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar * [Get update status](/es/api/update/status): Obtén el estado de una actualización y otros detalles de tu documentación. * [Trigger preview deployment](/es/api/preview/trigger): Crea o actualiza una implementación de vista previa para una rama específica. * [Trigger automation](/es/api/automations/trigger): Ejecuta una automatización programada bajo demanda. -* [Detect AI-sounding prose](/es/api/admin/deslop): Analiza una página en busca de prosa generada por IA y obtén sugerencias de reescritura hechas por humanos. * [Create agent job](/es/api/agent/v2/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente. * [Get agent job](/es/api/agent/v2/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica. * [Send follow-up message](/es/api/agent/v2/send-message): Envía un mensaje de seguimiento a una tarea de agente existente. @@ -78,7 +77,7 @@ Mintlify utiliza tres tipos de API keys, cada una con un conjunto diferente de e ### Clave de la API de administrador -Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Trigger preview deployment](/es/api/preview/trigger), [Trigger automation](/es/api/automations/trigger), [Detect AI-sounding prose](/es/api/admin/deslop), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). +Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Trigger preview deployment](/es/api/preview/trigger), [Trigger automation](/es/api/automations/trigger), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). Las claves de la API de administrador comienzan con el prefijo `mint_`. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 48dd287e88..fa4e2021d0 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -551,51 +551,6 @@ La puntuación general utiliza puntuación ponderada, por lo que las verificacio --- -
- ## `mint deslop` -
- -Comprueba las páginas de documentación para detectar prosa que suena a IA y obtén sugerencias de reescritura. Requiere autenticación con `mint login`. - -```bash -mint deslop [files...] [flags] -``` - -| Argumento | Descripción | -| --- | --- | -| `files` | Opcional. Rutas o globs a comprobar. Si se omite, el comando comprueba las páginas `.md` y `.mdx` que han cambiado en tu directorio de trabajo (diff de Git más archivos sin seguimiento). | - -| Flag | Descripción | -| --- | --- | -| `--format` | Formato de salida: `table` (predeterminado, con colores), `plain` (redirigible) o `json`. | -| `--subdomain` | Subdominio de documentación con el que comparar. Por defecto, tu subdominio configurado. | -| `--threshold` | Marca una página como fallida cuando la suma de sus fracciones generada por IA y asistida por IA sea mayor que este valor, de `0` a `1`. Por defecto, `0.5`. | -| `--fix-whitespace` | Normaliza los espacios en blanco de la prosa en los archivos comprobados (espacios finales, secuencias de líneas en blanco y caracteres Unicode invisibles). Omite los bloques de código y el frontmatter. | - -Para cada página marcada, el comando informa la fracción escrita por IA, los pasajes específicos que se detectan como generados por IA con sus números de línea, y sugerencias de reescritura en estilo humano. - -Cada página comprobada consume un crédito de IA. Las páginas con menos de 50 palabras se omiten y no se cobran. Si alguna página alcanza el umbral o lo supera, o si una comprobación devuelve un error, el comando termina con el código `1`. Si todas las páginas están limpias, el comando termina con el código `0`. Esto te permite ejecutarlo en un bucle de reescritura o en CI. - -
- ### Ejemplos -
- -```bash -# Comprobar las páginas modificadas en tu directorio de trabajo -mint deslop - -# Comprobar una página específica -mint deslop docs/guide.mdx - -# Comprobar todas las páginas MDX y emitir JSON para scripting -mint deslop "docs/**/*.mdx" --format json - -# Además, limpiar los espacios en blanco en los archivos comprobados -mint deslop docs/guide.mdx --fix-whitespace -``` - ---- -
## `mint format`
diff --git a/es/cli/index.mdx b/es/cli/index.mdx index 3b9b4d9d20..4ff122249e 100644 --- a/es/cli/index.mdx +++ b/es/cli/index.mdx @@ -45,12 +45,6 @@ Ejecuta `mint broken-links` para encontrar enlaces rotos y `mint a11y` para veri Ejecuta `mint score` para evaluar qué tan bien pueden los agentes navegar por un sitio de documentación. Sin argumentos, el comando evalúa tu subdominio configurado. Pasa una URL para evaluar cualquier otro sitio. El comando muestra una puntuación general de preparación y resultados de verificaciones individuales. -
- ### Detecta prosa que suene a IA -
- -Ejecuta `mint deslop` para revisar tus páginas en busca de prosa generada por IA. Obtén sugerencias de reescritura con estilo humano. Sin argumentos, el comando revisa las páginas que has cambiado. Señala los fragmentos específicos que parecen generados por IA para que puedas revisarlos. -
### Formatea archivos MDX
diff --git a/fr.json b/fr.json index 06109d6e25..bfab8f7bf0 100644 --- a/fr.json +++ b/fr.json @@ -373,8 +373,7 @@ "fr/api/update/trigger", "fr/api/update/status", "fr/api/preview/trigger", - "fr/api/automations/trigger", - "fr/api/admin/deslop" + "fr/api/automations/trigger" ] }, { diff --git a/fr/admin-openapi.json b/fr/admin-openapi.json index aca45fe6a3..99d7e253c5 100644 --- a/fr/admin-openapi.json +++ b/fr/admin-openapi.json @@ -16,84 +16,6 @@ } ], "paths": { - "/v1/deslop/{projectId}": { - "post": { - "summary": "Détecter la prose qui sonne comme de l'IA dans une page", - "description": "Analyse une page à la recherche de prose générée par IA et renvoie les passages signalés ainsi que des suggestions de réécriture. Consomme un crédit IA par page vérifiée. Ignore les pages de moins de 50 mots. Limité à 30 requêtes par minute par adresse IP client.", - "parameters": [ - { - "name": "projectId", - "in": "path", - "required": true, - "schema": { "type": "string" }, - "description": "L'identifiant de votre projet. Il peut être copié depuis la page [Clés d'API](https://app.mintlify.com/settings/organization/api-keys) de votre tableau de bord." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": ["path", "content"], - "properties": { - "path": { - "type": "string", - "minLength": 1, - "description": "Chemin de la page relatif au dépôt, utilisé uniquement pour le rapport." - }, - "content": { - "type": "string", - "maxLength": 1000000, - "description": "Le contenu MDX ou Markdown brut de la page à vérifier." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "La page a été vérifiée, ou ignorée parce qu'elle était trop courte.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/DeslopResult" } } - } - }, - "400": { - "description": "Corps de requête invalide.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "402": { - "description": "Crédits IA insuffisants.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "429": { - "description": "Limite de débit dépassée.", - "content": { - "text/plain": { - "schema": { - "type": "string", - "example": "Trop de requêtes, veuillez réessayer plus tard." - } - } - } - }, - "503": { - "description": "La détection est temporairement indisponible. Aucun crédit n'est facturé.", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "500": { - "description": "Une erreur inattendue s'est produite lors du traitement de la page." - } - } - } - }, "/v1/agent/{projectId}/job": { "post": { "summary": "Créer une tâche d’agent (v1)", @@ -681,63 +603,6 @@ }, "components": { "schemas": { - "DeslopResult": { - "type": "object", - "required": ["path", "skipped", "creditsCharged"], - "properties": { - "path": { "type": "string", "description": "Le chemin fourni dans la requête." }, - "skipped": { - "type": "string", - "nullable": true, - "enum": ["too_short", null], - "description": "Raison pour laquelle la page a été ignorée, ou null lorsque la page a été vérifiée. `too_short` signifie que la page contenait moins de 50 mots de prose et n'a pas été facturée." - }, - "predictionShort": { - "type": "string", - "enum": ["AI", "AI-Assisted", "Human", "Mixed"], - "description": "Verdict global pour la page. Présent uniquement lorsque la page a été vérifiée." - }, - "fractionAi": { "type": "number", "description": "Fraction de la page détectée comme générée par IA (0-1)." }, - "fractionAiAssisted": { "type": "number", "description": "Fraction détectée comme assistée par IA (0-1)." }, - "fractionHuman": { "type": "number", "description": "Fraction détectée comme rédigée par un humain (0-1)." }, - "windows": { - "type": "array", - "description": "Passages signalés (non humains). Présent uniquement lorsque la page a été vérifiée.", - "items": { "$ref": "#/components/schemas/DeslopWindow" } - }, - "creditsCharged": { "type": "integer", "description": "Crédits IA facturés pour cette requête (0 lorsque la page est ignorée)." } - } - }, - "DeslopWindow": { - "type": "object", - "required": ["text", "label", "aiAssistanceScore", "startLine", "endLine"], - "properties": { - "text": { "type": "string", "description": "Le texte du passage signalé." }, - "label": { "type": "string", "description": "Étiquette de détection pour le passage, par exemple `AI-Generated`." }, - "aiAssistanceScore": { "type": "number", "description": "Score d'assistance par IA pour le passage (0-1)." }, - "confidence": { - "description": "Confiance de la détection, renvoyée sous forme d'étiquette telle que `High` ou de score numérique.", - "oneOf": [ - { "type": "string" }, - { "type": "number" } - ] - }, - "startLine": { "type": "integer", "description": "Ligne de début du passage dans le contenu d'origine (indexée à partir de 1)." }, - "endLine": { "type": "integer", "description": "Ligne de fin du passage dans le contenu d'origine (indexée à partir de 1)." }, - "rewrites": { - "type": "array", - "description": "Suggestions de réécriture au style humain du passage.", - "items": { - "type": "object", - "required": ["text", "rationale"], - "properties": { - "text": { "type": "string", "description": "Le passage réécrit." }, - "rationale": { "type": "string", "description": "Pourquoi la réécriture se lit de manière plus humaine." } - } - } - } - } - }, "AgentJob": { "type": "object", "properties": { diff --git a/fr/api/admin/deslop.mdx b/fr/api/admin/deslop.mdx deleted file mode 100644 index 3a7ec109ba..0000000000 --- a/fr/api/admin/deslop.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Détecter la prose qui sonne comme de l'IA" -openapi: /fr/admin-openapi.json POST /v1/deslop/{projectId} -keywords: ["deslop", "détection IA", "slop", "prose", "qualité du contenu"] ---- - -Cet endpoint analyse une page de documentation à la recherche de prose générée par IA et renvoie les passages signalés ainsi que des suggestions de réécriture au style humain. - -Authentifiez-vous avec une [clé d'API admin](/fr/api/introduction#admin-api-key). - -
- ## Crédits -
- -- Consomme 1 crédit IA par page vérifiée. -- Les pages de moins de 50 mots sont ignorées et non facturées. La réponse renvoie `skipped: "too_short"` avec `creditsCharged: 0`. -- Si la détection est temporairement indisponible, l'endpoint renvoie `503` et aucun crédit n'est facturé. -- L'endpoint accepte jusqu'à 30 requêtes par minute par adresse IP client. - -
- ## Réponse -
- -Les pages vérifiées renvoient un verdict (`predictionShort`), des fractions IA et humaine, ainsi qu'un tableau `windows` des passages signalés. Chaque fenêtre comprend une plage de lignes et peut inclure d'une à trois suggestions de réécriture. - -
- ## Utilisation -
- -```bash -curl -X POST https://api.mintlify.com/v1/deslop/{projectId} \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{ - "path": "guides/quickstart.mdx", - "content": "# Quickstart\n\nWelcome to our comprehensive documentation..." - }' -``` diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index 419a8f2c2c..cfc484ea63 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -21,7 +21,6 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir * [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation. * [Trigger preview deployment](/fr/api/preview/trigger): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. * [Trigger automation](/fr/api/automations/trigger): Exécute une automatisation planifiée à la demande. -* [Detect AI-sounding prose](/fr/api/admin/deslop) : Analysez une page pour détecter la prose générée par IA et obtenez des suggestions de réécriture humaine. * [Create agent job](/fr/api/agent/v2/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation. * [Get agent job](/fr/api/agent/v2/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique. * [Send follow-up message](/fr/api/agent/v2/send-message): Envoyez un message de suivi à une tâche d'agent existante. @@ -78,7 +77,7 @@ Mintlify utilise trois types de clés d'API, chacune associée à un ensemble di ### Clé d'API administrateur -Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Trigger automation](/fr/api/automations/trigger), [Detect AI-sounding prose](/fr/api/admin/deslop), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats). +Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Trigger automation](/fr/api/automations/trigger), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats). Les clés d'API administrateur commencent par le préfixe `mint_`. diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 352593718e..369e6d660d 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -553,51 +553,6 @@ Le score global utilise une notation pondérée, de sorte que les vérifications --- -
- ## `mint deslop` -
- -Vérifier les pages de documentation à la recherche de prose qui sonne comme de l'IA et obtenir des suggestions de réécriture. Nécessite une authentification avec `mint login`. - -```bash -mint deslop [files...] [flags] -``` - -| Argument | Description | -| --- | --- | -| `files` | Facultatif. Chemins ou globs à vérifier. S'ils sont omis, la commande vérifie les pages `.md` et `.mdx` qui ont changé dans votre arbre de travail (diff Git plus fichiers non suivis). | - -| Flag | Description | -| --- | --- | -| `--format` | Format de sortie : `table` (par défaut, coloré), `plain` (redirigeable) ou `json`. | -| `--subdomain` | Sous-domaine de la documentation à utiliser pour la vérification. Par défaut, votre sous-domaine configuré. | -| `--threshold` | Faire échouer une page lorsque la somme de ses fractions générée par IA et assistée par IA est supérieure à cette valeur, de `0` à `1`. Par défaut `0.5`. | -| `--fix-whitespace` | Normaliser les espaces de la prose dans les fichiers vérifiés (espaces en fin de ligne, suites de lignes vides et caractères Unicode invisibles). Ignore les blocs de code et le frontmatter. | - -Pour chaque page signalée, la commande indique la fraction rédigée par IA, les passages spécifiques qui se lisent comme générés par IA avec leurs numéros de ligne, ainsi que des suggestions de réécriture au style humain. - -Chaque page vérifiée consomme un crédit IA. Les pages de moins de 50 mots sont ignorées et non facturées. Si une page atteint ou dépasse le seuil, ou si une vérification renvoie une erreur, la commande se termine avec le code `1`. Si toutes les pages sont propres, la commande se termine avec le code `0`. Cela vous permet de l'exécuter dans une boucle de réécriture ou en CI. - -
- ### Exemples -
- -```bash -# Vérifier les pages modifiées dans votre arbre de travail -mint deslop - -# Vérifier une page spécifique -mint deslop docs/guide.mdx - -# Vérifier toutes les pages MDX et émettre du JSON pour du scripting -mint deslop "docs/**/*.mdx" --format json - -# Nettoyer également les espaces dans les fichiers vérifiés -mint deslop docs/guide.mdx --fix-whitespace -``` - ---- -
## `mint format`
diff --git a/fr/cli/index.mdx b/fr/cli/index.mdx index 961abb73a1..f222aae2a0 100644 --- a/fr/cli/index.mdx +++ b/fr/cli/index.mdx @@ -45,12 +45,6 @@ Exécutez `mint broken-links` pour trouver les liens cassés, `mint a11y` pour v Exécutez `mint score` pour évaluer dans quelle mesure les agents peuvent naviguer sur un site de documentation. Sans argument, la commande évalue votre sous-domaine configuré. Passez une URL pour évaluer tout autre site. La commande affiche un score global de préparation et les résultats des vérifications individuelles. -
- ### Détectez la prose générée par IA -
- -Exécutez `mint deslop` pour vérifier vos pages à la recherche de prose générée par IA et obtenir des suggestions de réécriture au style humain. Sans argument, la commande vérifie les pages que vous avez modifiées. Elle signale les passages précis qui semblent générés par IA afin que vous puissiez les réviser. -
### Formatez les fichiers MDX
diff --git a/zh.json b/zh.json index fe2b0ca253..f2056ca7f0 100644 --- a/zh.json +++ b/zh.json @@ -373,8 +373,7 @@ "zh/api/update/trigger", "zh/api/update/status", "zh/api/preview/trigger", - "zh/api/automations/trigger", - "zh/api/admin/deslop" + "zh/api/automations/trigger" ] }, { diff --git a/zh/admin-openapi.json b/zh/admin-openapi.json index 087ee7ee90..072720c9c2 100644 --- a/zh/admin-openapi.json +++ b/zh/admin-openapi.json @@ -16,84 +16,6 @@ } ], "paths": { - "/v1/deslop/{projectId}": { - "post": { - "summary": "检测页面中 AI 风格的文本", - "description": "分析页面中是否存在 AI 生成的文本,并返回被标记的段落以及建议的改写。每检查一个页面消耗 1 个 AI 积分。少于 50 个词的页面会被跳过。针对每个客户端 IP 地址每分钟最多 30 个请求。", - "parameters": [ - { - "name": "projectId", - "in": "path", - "required": true, - "schema": { "type": "string" }, - "description": "你的项目 ID。可从你的控制台中的 [API keys](https://app.mintlify.com/settings/organization/api-keys) 页面复制。" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": ["path", "content"], - "properties": { - "path": { - "type": "string", - "minLength": 1, - "description": "页面的仓库相对路径,仅用于报告。" - }, - "content": { - "type": "string", - "maxLength": 1000000, - "description": "要检查的页面的原始 MDX 或 Markdown 内容。" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "页面已被检查,或因过短而被跳过。", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/DeslopResult" } } - } - }, - "400": { - "description": "请求体无效。", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "402": { - "description": "AI 积分不足。", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "429": { - "description": "超出速率限制。", - "content": { - "text/plain": { - "schema": { - "type": "string", - "example": "请求过多,请稍后再试。" - } - } - } - }, - "503": { - "description": "检测暂时不可用。不扣除积分。", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } - }, - "500": { - "description": "处理页面时发生了意外错误。" - } - } - } - }, "/v1/agent/{projectId}/job": { "post": { "summary": "创建代理任务(v1)", @@ -681,63 +603,6 @@ }, "components": { "schemas": { - "DeslopResult": { - "type": "object", - "required": ["path", "skipped", "creditsCharged"], - "properties": { - "path": { "type": "string", "description": "请求中传入的 path。" }, - "skipped": { - "type": "string", - "nullable": true, - "enum": ["too_short", null], - "description": "页面被跳过的原因;如果页面已被检查则为 null。`too_short` 表示页面正文少于 50 个词,且未被计费。" - }, - "predictionShort": { - "type": "string", - "enum": ["AI", "AI-Assisted", "Human", "Mixed"], - "description": "页面的整体判定结果。仅在页面已被检查时出现。" - }, - "fractionAi": { "type": "number", "description": "被识别为 AI 生成的页面比例(0-1)。" }, - "fractionAiAssisted": { "type": "number", "description": "被识别为 AI 辅助的比例(0-1)。" }, - "fractionHuman": { "type": "number", "description": "被识别为人类撰写的比例(0-1)。" }, - "windows": { - "type": "array", - "description": "被标记的(非人类)段落。仅在页面已被检查时出现。", - "items": { "$ref": "#/components/schemas/DeslopWindow" } - }, - "creditsCharged": { "type": "integer", "description": "本次请求扣除的 AI 积分数(被跳过时为 0)。" } - } - }, - "DeslopWindow": { - "type": "object", - "required": ["text", "label", "aiAssistanceScore", "startLine", "endLine"], - "properties": { - "text": { "type": "string", "description": "被标记的段落文本。" }, - "label": { "type": "string", "description": "段落的检测标签,例如 `AI-Generated`。" }, - "aiAssistanceScore": { "type": "number", "description": "段落的 AI 辅助评分(0-1)。" }, - "confidence": { - "description": "检测置信度,返回值可能为 `High` 之类的标签或数值。", - "oneOf": [ - { "type": "string" }, - { "type": "number" } - ] - }, - "startLine": { "type": "integer", "description": "段落在原始内容中的起始行号(从 1 开始)。" }, - "endLine": { "type": "integer", "description": "段落在原始内容中的结束行号(从 1 开始)。" }, - "rewrites": { - "type": "array", - "description": "建议的人类风格改写。", - "items": { - "type": "object", - "required": ["text", "rationale"], - "properties": { - "text": { "type": "string", "description": "改写后的段落。" }, - "rationale": { "type": "string", "description": "该改写更贴近人类风格的原因。" } - } - } - } - } - }, "AgentJob": { "type": "object", "properties": { diff --git a/zh/api/admin/deslop.mdx b/zh/api/admin/deslop.mdx deleted file mode 100644 index f4dfdc38ec..0000000000 --- a/zh/api/admin/deslop.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "检测 AI 风格的文本" -openapi: /zh/admin-openapi.json POST /v1/deslop/{projectId} -keywords: ["deslop", "AI 检测", "slop", "文本", "内容质量"] ---- - -此端点分析文档页面中是否存在 AI 生成的文本,并返回被标记的段落以及建议的人类风格改写。 - -使用[管理员 API 密钥](/zh/api/introduction#admin-api-key)进行身份验证。 - -
- ## 积分 -
- -- 每检查一个页面消耗 1 个 AI 积分。 -- 少于 50 个词的页面会被跳过,不计费。响应中会返回 `skipped: "too_short"`,且 `creditsCharged: 0`。 -- 如果检测暂时不可用,端点会返回 `503`,不扣除积分。 -- 该端点针对每个客户端 IP 地址每分钟最多接受 30 个请求。 - -
- ## 响应 -
- -已检查的页面会返回判定结果(`predictionShort`)、AI 撰写和人类撰写的比例,以及包含被标记段落的 `windows` 数组。每个 window 包含一个行号范围,并可包含一到三条建议的改写。 - -
- ## 用法 -
- -```bash -curl -X POST https://api.mintlify.com/v1/deslop/{projectId} \ - -H "Authorization: Bearer mint_xxxxx" \ - -H "Content-Type: application/json" \ - -d '{ - "path": "guides/quickstart.mdx", - "content": "# Quickstart\n\nWelcome to our comprehensive documentation..." - }' -``` diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index 4d385a9a99..93a0fa01f6 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -21,7 +21,6 @@ Mintlify 的 REST(Representational State Transfer)API 让你可以以编程 * [Get update status](/zh/api/update/status):获取某次更新的状态以及与您的文档相关的其他详细信息。 * [Trigger preview deployment](/zh/api/preview/trigger):为特定分支创建或更新预览部署。 * [Trigger automation](/zh/api/automations/trigger):按需运行已计划的自动化。 -* [Detect AI-sounding prose](/zh/api/admin/deslop):分析页面中由 AI 生成的文字,并获取人工风格的改写建议。 * [Create agent job](/zh/api/agent/v2/create-agent-job):创建一个代理任务以自动编辑您的文档。 * [Get agent job](/zh/api/agent/v2/get-agent-job):获取特定代理任务的详细信息和状态。 * [Send follow-up message](/zh/api/agent/v2/send-message):向已有的代理任务发送后续消息。 @@ -78,7 +77,7 @@ Mintlify 使用三种 API key,每种 key 对应不同的端点集合: ### 管理员 API key -使用管理员 API key 对发送到 [Trigger update](/zh/api/update/trigger)、[Get update status](/zh/api/update/status)、[Trigger preview deployment](/zh/api/preview/trigger)、[Trigger automation](/zh/api/automations/trigger)、[Detect AI-sounding prose](/zh/api/admin/deslop)、[Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job)、[Send follow-up message](/zh/api/agent/v2/send-message)、[Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats) 的请求进行身份验证。 +使用管理员 API key 对发送到 [Trigger update](/zh/api/update/trigger)、[Get update status](/zh/api/update/status)、[Trigger preview deployment](/zh/api/preview/trigger)、[Trigger automation](/zh/api/automations/trigger)、[Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job)、[Send follow-up message](/zh/api/agent/v2/send-message)、[Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats) 的请求进行身份验证。 管理员 API key 以 `mint_` 前缀开头。 diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 79bb35dac1..5fc9df0293 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -553,51 +553,6 @@ mint score docs.example.com --- -
- ## `mint deslop` -
- -检查文档页面中是否存在 AI 风格的文本,并获取改写建议。需要使用 `mint login` 进行身份验证。 - -```bash -mint deslop [files...] [flags] -``` - -| 参数 | 描述 | -| --- | --- | -| `files` | 可选。要检查的路径或通配符。如果省略,该命令将检查工作树中已更改的 `.md` 和 `.mdx` 页面(Git diff 加上未跟踪的文件)。 | - -| 选项 | 描述 | -| --- | --- | -| `--format` | 输出格式:`table`(默认,带颜色)、`plain`(可管道传输)或 `json`。 | -| `--subdomain` | 要检查的文档子域名。默认使用你配置的子域名。 | -| `--threshold` | 当页面的 AI 生成和 AI 辅助比例之和大于此值时判定为不通过,取值范围为 `0` 到 `1`。默认为 `0.5`。 | -| `--fix-whitespace` | 规范化所检查文件中的正文空白(尾随空格、连续空行以及不可见的 Unicode 字符)。跳过代码块和 frontmatter。 | - -对于每个被标记的页面,该命令会报告 AI 撰写比例、被识别为 AI 生成的具体段落及其行号,以及建议的人类风格改写。 - -每检查一个页面消耗 1 个 AI 积分。少于 50 个词的页面会被跳过,不计费。当任意页面达到或超过阈值,或某次检查返回错误时,命令以退出码 `1` 结束;当所有页面都通过时,命令以退出码 `0` 结束。方便你在改写循环或 CI 中运行。 - -
- ### 示例 -
- -```bash -# 检查工作树中已更改的页面 -mint deslop - -# 检查特定页面 -mint deslop docs/guide.mdx - -# 检查所有 MDX 页面并输出 JSON 便于脚本处理 -mint deslop "docs/**/*.mdx" --format json - -# 同时清理所检查文件中的空白 -mint deslop docs/guide.mdx --fix-whitespace -``` - ---- -
## `mint format`
diff --git a/zh/cli/index.mdx b/zh/cli/index.mdx index cd743517b1..fa5b7a0bc0 100644 --- a/zh/cli/index.mdx +++ b/zh/cli/index.mdx @@ -45,12 +45,6 @@ CLI 在你的本地机器上运行,在需要实时数据时连接到你的 Min 运行 `mint score` 评估 agent 在文档站点上的导航能力。不带参数时,该命令会对你配置的子域名进行评分。传入 URL 可评分任意其他站点。该命令显示总体就绪度评分和各项检查结果。 -
- ### 检测疑似 AI 生成的文字 -
- -运行 `mint deslop` 检查页面中由 AI 生成的文字,并获取更符合人工写作风格的改写建议。不带参数时,该命令会检查你已修改的页面。它会标记出读起来像 AI 生成的具体段落,方便你进行修改。 -
### 格式化 MDX 文件