From 5f942399d3333023d93bd00cf5f11580825734bf Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 15:24:43 +0000 Subject: [PATCH 1/4] docs: fix Vale warnings from PRs merged in the last week --- advanced-support.mdx | 2 +- ai/model-context-protocol.mdx | 8 +++---- create/changelogs.mdx | 2 +- guides/seo.mdx | 8 +++---- optimize/seo.mdx | 6 ++--- organize/settings-structure.mdx | 40 ++++++++++++++++----------------- 6 files changed, 33 insertions(+), 33 deletions(-) diff --git a/advanced-support.mdx b/advanced-support.mdx index ba82ff09d2..9d072337c5 100644 --- a/advanced-support.mdx +++ b/advanced-support.mdx @@ -11,7 +11,7 @@ Mintlify offers three support tiers. The right tier depends on the level of comm | | Standard | Advanced Slack | Dedicated CSM | |---|---|---|---| | **Tier** | 1 (included) | 2 (add-on) | 3 (add-on) | -| **How issues reach us** | Email or dashboard | AI routing from Slack | CSM escalates from Slack | +| **How issues reach us** | email or dashboard | AI routing from Slack | CSM escalates from Slack | | **Response time targets** | Best effort | P0–P3 | P0–P3 | | **Named contact** | No | No | Yes | | **Monthly check-ins** | No | No | Yes | diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index d0c50a96ab..bb31a00ec8 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -170,10 +170,10 @@ Each server card includes the standard discovery fields and a `tools` array that The built-in search and query docs filesystem tools are read-only and non-destructive with the following annotations: -- `readOnlyHint: true` — the tool does not modify any state. -- `destructiveHint: false` — the tool has no destructive side effects. -- `idempotentHint: true` — repeated calls with the same arguments return equivalent results. -- `openWorldHint: false` — the tool operates against your indexed documentation rather than the open web. +- `readOnlyHint: true`—the tool does not modify any state. +- `destructiveHint: false`—the tool has no destructive side effects. +- `idempotentHint: true`—repeated calls with the same arguments return equivalent results. +- `openWorldHint: false`—the tool operates against your indexed documentation rather than the open web. MCP clients can use these annotations to surface tool safety information to users or to allow read-only tools to run without explicit approval. diff --git a/create/changelogs.mdx b/create/changelogs.mdx index ea958236a1..7ac6230afb 100644 --- a/create/changelogs.mdx +++ b/create/changelogs.mdx @@ -136,7 +136,7 @@ RSS feed entries contain pure Markdown only. They exclude components, code, and RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include: * [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) -* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier +* [email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier * Discord bots like [Readybot](https://readybot.io) or [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot) To make the RSS feed discoverable, you can display an RSS icon button that links to the feed at the top of the page. Add `rss: true` to the page frontmatter: diff --git a/guides/seo.mdx b/guides/seo.mdx index 7ab9e786e6..954a41bbf2 100644 --- a/guides/seo.mdx +++ b/guides/seo.mdx @@ -146,7 +146,7 @@ Check it monthly and prioritize pages with high impressions but low clicks (your -There's no universal ideal length. Pages should be long enough to comprehensively cover the topic and short enough to stay focused. A getting started guide might be 800 words. A detailed API reference might be 3,000. What matters is that users can accomplish their goal from the page — if they need to leave to find additional information, the page is probably too thin. Generally, pages under 300 words struggle to rank for competitive queries because they don't demonstrate topical depth. +There's no universal ideal length. Pages should be long enough to comprehensively cover the topic and short enough to stay focused. A getting started guide might be 800 words. A detailed API reference might be 3,000. What matters is that users can accomplish their goal from the page—if they need to leave to find additional information, the page is probably too thin. Generally, pages under 300 words struggle to rank for competitive queries because they don't demonstrate topical depth. @@ -158,14 +158,14 @@ In [Google Search Console](https://search.google.com/search-console), go to **Si -Update documentation whenever the product changes — accuracy is the most important signal. For SEO specifically, pages that haven't been touched in over a year may benefit from a review to add missing information, update examples, and expand thin sections. Use Google Search Console to prioritize: pages losing traffic or dropping in position are candidates for a refresh. +Update documentation whenever the product changes—accuracy is the most important signal. For SEO specifically, pages that haven't been touched in over a year may benefit from a review to add missing information, update examples, and expand thin sections. Use Google Search Console to prioritize: pages losing traffic or dropping in position are candidates for a refresh. -SEO (Search Engine Optimization) focuses on ranking in traditional search engines like Google and Bing. GEO (Generative Engine Optimization) focuses on being cited by AI-powered tools like ChatGPT, Perplexity, and Google AI Overviews. The fundamentals overlap — accurate, well-structured content performs well in both — but GEO has some additional practices around formatting for AI parsing. See the [GEO guide](/guides/geo) for details. +SEO (Search Engine Optimization) focuses on ranking in traditional search engines like Google and Bing. GEO (Generative Engine Optimization) focuses on being cited by AI-powered tools like ChatGPT, Perplexity, and Google AI Overviews. The fundamentals overlap—accurate, well-structured content performs well in both—but GEO has some additional practices around formatting for AI parsing. See the [GEO guide](/guides/geo) for details. -Mintlify handles the technical foundation: sitemap generation, semantic HTML, canonical tags, meta tag generation, and mobile optimization. What Mintlify can't do for you is write better titles, do keyword research, build internal links, or expand thin content — those require editorial decisions. The [SEO configuration reference](/optimize/seo) covers everything you can control through `docs.json` and page frontmatter. +Mintlify handles the technical foundation: sitemap generation, semantic HTML, canonical tags, meta tag generation, and mobile optimization. What Mintlify can't do for you is write better titles, do keyword research, build internal links, or expand thin content—those require editorial decisions. The [SEO configuration reference](/optimize/seo) covers everything you can control through `docs.json` and page frontmatter. diff --git a/optimize/seo.mdx b/optimize/seo.mdx index d9edeee55d..de1de09f82 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -350,9 +350,9 @@ Content-Signal: ai-train=yes, search=yes, ai-input=yes The default signals opt your documentation in to: -- `ai-train=yes` — Training AI models. -- `search=yes` — Building search indexes. -- `ai-input=yes` — Generating AI answers, including in retrieval-augmented generation and AI assistants. +- `ai-train=yes`—Training AI models. +- `search=yes`—Building search indexes. +- `ai-input=yes`—Generating AI answers, including in retrieval-augmented generation and AI assistants. These defaults help AI tools like ChatGPT, Claude, and Perplexity discover and cite your documentation. To change the signals, [add a custom `robots.txt`](#custom-sitemaps-and-robotstxt-files) at the root of your project. Mintlify serves custom files as-is, without the default Content-Signal directives. diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx index f8d8d84d09..25c62c5be6 100644 --- a/organize/settings-structure.mdx +++ b/organize/settings-structure.mdx @@ -376,23 +376,23 @@ The contextual menu gives users quick access to AI tools and page actions. It ap Actions available in the contextual menu. The first option in the array appears as the default action. Built-in options: - - `"add-mcp"` — Add your MCP server to the user's configuration - - `"aistudio"` — Send the current page to Google AI Studio - - `"assistant"` — Open the AI assistant with the current page as context - - `"copy"` — Copy the current page as Markdown to the clipboard - - `"chatgpt"` — Send the current page to ChatGPT - - `"claude"` — Send the current page to Claude - - `"cursor"` — Install your hosted MCP server in Cursor - - `"devin"` — Send the current page to Devin - - `"devin-mcp"` — Install your hosted MCP server in Devin - - `"download-pdf"` — Download the current page as a PDF - - `"download-spec"` — Download the deployment's OpenAPI specs (single file, or zipped if multiple) - - `"grok"` — Send the current page to Grok - - `"mcp"` — Copy your MCP server URL to the clipboard - - `"perplexity"` — Send the current page to Perplexity - - `"view"` — View the current page as Markdown in a new tab - - `"vscode"` — Install your hosted MCP server in VS Code - - `"devin-desktop"` — Open Devin Desktop with the current page as context + - `"add-mcp"`—Add your MCP server to the user's configuration + - `"aistudio"`—Send the current page to Google AI Studio + - `"assistant"`—Open the AI assistant with the current page as context + - `"copy"`—Copy the current page as Markdown to the clipboard + - `"chatgpt"`—Send the current page to ChatGPT + - `"claude"`—Send the current page to Claude + - `"cursor"`—Install your hosted MCP server in Cursor + - `"devin"`—Send the current page to Devin + - `"devin-mcp"`—Install your hosted MCP server in Devin + - `"download-pdf"`—Download the current page as a PDF + - `"download-spec"`—Download the deployment's OpenAPI specs (single file, or zipped if multiple) + - `"grok"`—Send the current page to Grok + - `"mcp"`—Copy your MCP server URL to the clipboard + - `"perplexity"`—Send the current page to Perplexity + - `"view"`—View the current page as Markdown in a new tab + - `"vscode"`—Install your hosted MCP server in VS Code + - `"devin-desktop"`—Open Devin Desktop with the current page as context Define custom options as objects: @@ -410,9 +410,9 @@ The contextual menu gives users quick access to AI tools and page actions. It ap Link destination. Can be a URL string or an object with `base` and optional `query` parameters. Available placeholder values: - - `$page` — Current page content - - `$path` — Current page path - - `$mcp` — MCP server URL + - `$page`—Current page content + - `$path`—Current page path + - `$mcp`—MCP server URL From 72f482e5b6365b8bd35076e342cf1306bb8fab93 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 15:28:16 +0000 Subject: [PATCH 2/4] docs: mirror Vale style fixes into es/fr/zh translations --- es/guides/seo.mdx | 8 +++--- es/optimize/seo.mdx | 10 ++++---- es/organize/settings-structure.mdx | 40 +++++++++++++++--------------- fr/ai/model-context-protocol.mdx | 10 ++++---- fr/guides/seo.mdx | 8 +++--- fr/optimize/seo.mdx | 10 ++++---- fr/organize/settings-structure.mdx | 40 +++++++++++++++--------------- zh/ai/model-context-protocol.mdx | 8 +++--- zh/create/changelogs.mdx | 2 +- zh/optimize/seo.mdx | 10 ++++---- zh/organize/settings-structure.mdx | 38 ++++++++++++++-------------- 11 files changed, 92 insertions(+), 92 deletions(-) diff --git a/es/guides/seo.mdx b/es/guides/seo.mdx index 673013954f..69e4d3afe7 100644 --- a/es/guides/seo.mdx +++ b/es/guides/seo.mdx @@ -171,7 +171,7 @@ Revísalo mensualmente y prioriza las páginas con muchas impresiones pero pocos -No hay una longitud ideal universal. Las páginas deberían ser lo suficientemente largas para cubrir el tema de forma completa y lo suficientemente cortas para mantenerse enfocadas. Una guía de inicio rápido podría tener 800 palabras. Una referencia de API detallada podría tener 3,000. Lo que importa es que los usuarios puedan lograr su objetivo desde la página — si necesitan irse para encontrar información adicional, la página probablemente es demasiado superficial. En general, las páginas con menos de 300 palabras tienen dificultades para posicionar en consultas competitivas porque no demuestran profundidad temática. +No hay una longitud ideal universal. Las páginas deberían ser lo suficientemente largas para cubrir el tema de forma completa y lo suficientemente cortas para mantenerse enfocadas. Una guía de inicio rápido podría tener 800 palabras. Una referencia de API detallada podría tener 3,000. Lo que importa es que los usuarios puedan lograr su objetivo desde la página—si necesitan irse para encontrar información adicional, la página probablemente es demasiado superficial. En general, las páginas con menos de 300 palabras tienen dificultades para posicionar en consultas competitivas porque no demuestran profundidad temática. @@ -183,14 +183,14 @@ En [Google Search Console](https://search.google.com/search-console), ve a **Sit -Actualiza la documentación cada vez que el producto cambie — la precisión es la señal más importante. Específicamente para SEO, las páginas que no se han tocado en más de un año pueden beneficiarse de una revisión para agregar información faltante, actualizar ejemplos y expandir secciones superficiales. Usa Google Search Console para priorizar: las páginas que pierden tráfico o bajan de posición son candidatas para una actualización. +Actualiza la documentación cada vez que el producto cambie—la precisión es la señal más importante. Específicamente para SEO, las páginas que no se han tocado en más de un año pueden beneficiarse de una revisión para agregar información faltante, actualizar ejemplos y expandir secciones superficiales. Usa Google Search Console para priorizar: las páginas que pierden tráfico o bajan de posición son candidatas para una actualización. -SEO (Search Engine Optimization) se enfoca en posicionar en motores de búsqueda tradicionales como Google y Bing. GEO (Generative Engine Optimization) se enfoca en ser citado por herramientas impulsadas por IA como ChatGPT, Perplexity y Google AI Overviews. Los fundamentos se superponen — contenido preciso y bien estructurado funciona bien en ambos — pero GEO tiene algunas prácticas adicionales sobre el formato para el análisis por IA. Consulta la [guía de GEO](/es/guides/geo) para más detalles. +SEO (Search Engine Optimization) se enfoca en posicionar en motores de búsqueda tradicionales como Google y Bing. GEO (Generative Engine Optimization) se enfoca en ser citado por herramientas impulsadas por IA como ChatGPT, Perplexity y Google AI Overviews. Los fundamentos se superponen—contenido preciso y bien estructurado funciona bien en ambos—pero GEO tiene algunas prácticas adicionales sobre el formato para el análisis por IA. Consulta la [guía de GEO](/es/guides/geo) para más detalles. -Mintlify gestiona la base técnica: generación de sitemap, HTML semántico, etiquetas canónicas, generación de meta tags y optimización móvil. Lo que Mintlify no puede hacer por ti es escribir mejores títulos, investigar palabras clave, construir enlaces internos o expandir contenido superficial — eso requiere decisiones editoriales. La [referencia de configuración SEO](/es/optimize/seo) cubre todo lo que puedes controlar a través de `docs.json` y el frontmatter de la página. +Mintlify gestiona la base técnica: generación de sitemap, HTML semántico, etiquetas canónicas, generación de meta tags y optimización móvil. Lo que Mintlify no puede hacer por ti es escribir mejores títulos, investigar palabras clave, construir enlaces internos o expandir contenido superficial—eso requiere decisiones editoriales. La [referencia de configuración SEO](/es/optimize/seo) cubre todo lo que puedes controlar a través de `docs.json` y el frontmatter de la página. diff --git a/es/optimize/seo.mdx b/es/optimize/seo.mdx index 358c0eda66..5ab34bf685 100644 --- a/es/optimize/seo.mdx +++ b/es/optimize/seo.mdx @@ -368,9 +368,9 @@ Content-Signal: ai-train=yes, search=yes, ai-input=yes Las señales predeterminadas habilitan tu documentación para: -- `ai-train=yes` — Entrenamiento de modelos de IA. -- `search=yes` — Creación de índices de búsqueda. -- `ai-input=yes` — Generación de respuestas con IA, incluyendo generación aumentada por recuperación y asistentes de IA. +- `ai-train=yes`—Entrenamiento de modelos de IA. +- `search=yes`—Creación de índices de búsqueda. +- `ai-input=yes`—Generación de respuestas con IA, incluyendo generación aumentada por recuperación y asistentes de IA. Estos valores por defecto ayudan a que herramientas de IA como ChatGPT, Claude y Perplexity descubran y citen tu documentación. Para cambiar las señales, [añade un `robots.txt` personalizado](#custom-sitemaps-and-robotstxt-files) en la raíz de tu proyecto. Mintlify sirve los archivos personalizados tal cual, sin las directivas Content-Signal predeterminadas. @@ -438,8 +438,8 @@ Usa esta opción cuando quieras mantener un despliegue en línea para revisión Esta opción funciona junto con otros controles de indexación: -- **`noindex` por página** — Los ajustes `noindex: true` en el frontmatter de una página siguen aplicándose cuando la opción a nivel de proyecto está desactivada. La opción a nivel de proyecto anula los ajustes por página cuando está activada, por lo que todas las páginas se tratan como `noindex`. -- **`robots.txt` personalizado** — Si tienes un [`robots.txt` personalizado](#custom-sitemaps-and-robotstxt-files) en la raíz de tu proyecto, Mintlify lo sirve sin modificaciones. La opción a nivel de proyecto no reemplaza un `robots.txt` personalizado, así que actualiza o elimina tu archivo personalizado por separado si necesitas que las reglas para rastreadores coincidan. +- **`noindex` por página**—Los ajustes `noindex: true` en el frontmatter de una página siguen aplicándose cuando la opción a nivel de proyecto está desactivada. La opción a nivel de proyecto anula los ajustes por página cuando está activada, por lo que todas las páginas se tratan como `noindex`. +- **`robots.txt` personalizado**—Si tienes un [`robots.txt` personalizado](#custom-sitemaps-and-robotstxt-files) en la raíz de tu proyecto, Mintlify lo sirve sin modificaciones. La opción a nivel de proyecto no reemplaza un `robots.txt` personalizado, así que actualiza o elimina tu archivo personalizado por separado si necesitas que las reglas para rastreadores coincidan.
## Mejores prácticas de SEO diff --git a/es/organize/settings-structure.mdx b/es/organize/settings-structure.mdx index 7f084ec62b..c17f40e05a 100644 --- a/es/organize/settings-structure.mdx +++ b/es/organize/settings-structure.mdx @@ -376,23 +376,23 @@ El menú contextual brinda a los usuarios acceso rápido a herramientas de IA y Acciones disponibles en el menú contextual. La primera opción del array aparece como la acción predeterminada. Opciones integradas: - - `"add-mcp"` — Agrega tu servidor MCP a la configuración del usuario - - `"aistudio"` — Envía la página actual a Google AI Studio - - `"assistant"` — Abre el asistente de IA con la página actual como contexto - - `"copy"` — Copia la página actual como Markdown en el portapapeles - - `"chatgpt"` — Envía la página actual a ChatGPT - - `"claude"` — Envía la página actual a Claude - - `"cursor"` — Instala tu servidor MCP alojado en Cursor - - `"devin"` — Envía la página actual a Devin - - `"devin-mcp"` — Instala tu servidor MCP alojado en Devin - - `"download-pdf"` — Descarga la página actual como un PDF - - `"download-spec"` — Descarga las especificaciones de OpenAPI del despliegue (un solo archivo, o comprimidas en zip si hay varias) - - `"grok"` — Envía la página actual a Grok - - `"mcp"` — Copia la URL de tu servidor MCP en el portapapeles - - `"perplexity"` — Envía la página actual a Perplexity - - `"view"` — Ver la página actual como Markdown en una nueva pestaña - - `"vscode"` — Instala tu servidor MCP alojado en VS Code - - `"devin-desktop"` — Abre Devin Desktop con la página actual como contexto + - `"add-mcp"`—Agrega tu servidor MCP a la configuración del usuario + - `"aistudio"`—Envía la página actual a Google AI Studio + - `"assistant"`—Abre el asistente de IA con la página actual como contexto + - `"copy"`—Copia la página actual como Markdown en el portapapeles + - `"chatgpt"`—Envía la página actual a ChatGPT + - `"claude"`—Envía la página actual a Claude + - `"cursor"`—Instala tu servidor MCP alojado en Cursor + - `"devin"`—Envía la página actual a Devin + - `"devin-mcp"`—Instala tu servidor MCP alojado en Devin + - `"download-pdf"`—Descarga la página actual como un PDF + - `"download-spec"`—Descarga las especificaciones de OpenAPI del despliegue (un solo archivo, o comprimidas en zip si hay varias) + - `"grok"`—Envía la página actual a Grok + - `"mcp"`—Copia la URL de tu servidor MCP en el portapapeles + - `"perplexity"`—Envía la página actual a Perplexity + - `"view"`—Ver la página actual como Markdown en una nueva pestaña + - `"vscode"`—Instala tu servidor MCP alojado en VS Code + - `"devin-desktop"`—Abre Devin Desktop con la página actual como contexto Define opciones personalizadas como objetos: @@ -410,9 +410,9 @@ El menú contextual brinda a los usuarios acceso rápido a herramientas de IA y Destino del enlace. Puede ser una cadena de URL o un objeto con `base` y parámetros `query` opcionales. Valores de marcador de posición disponibles: - - `$page` — Contenido de la página actual - - `$path` — Ruta de la página actual - - `$mcp` — URL del servidor MCP + - `$page`—Contenido de la página actual + - `$path`—Ruta de la página actual + - `$mcp`—URL del servidor MCP diff --git a/fr/ai/model-context-protocol.mdx b/fr/ai/model-context-protocol.mdx index d53815bfb8..3d7c2e53d6 100644 --- a/fr/ai/model-context-protocol.mdx +++ b/fr/ai/model-context-protocol.mdx @@ -40,7 +40,7 @@ Lorsqu'une application d'IA se connecte à votre serveur Search MCP, elle peut r Votre serveur Search MCP fournit deux outils que les agents peuvent utiliser : - **Search** : Recherche sur votre site pour trouver du contenu pertinent, en renvoyant des extraits avec des titres et des liens. Utilisez cet outil pour découvrir des informations ou trouver des pages correspondant à une requête. -- **Query docs filesystem** : Lit et parcourt le système de fichiers virtuel de votre site à l'aide de commandes de type shell. Utilisez cet outil pour parcourir et récupérer du contenu, ou extraire des sections spécifiques — y compris des lectures par lots sur plusieurs pages en un seul appel. +- **Query docs filesystem** : Lit et parcourt le système de fichiers virtuel de votre site à l'aide de commandes de type shell. Utilisez cet outil pour parcourir et récupérer du contenu, ou extraire des sections spécifiques—y compris des lectures par lots sur plusieurs pages en un seul appel. Les agents déterminent quand utiliser chaque outil en fonction du contexte de la conversation. Par exemple, un agent peut d'abord rechercher sur votre site pour trouver des pages pertinentes, puis utiliser l'outil query docs filesystem pour lire le contenu complet des résultats les plus pertinents. @@ -189,10 +189,10 @@ Chaque carte de serveur inclut les champs de découverte standards et un tableau Les outils intégrés de recherche et de requête du système de fichiers de documentation sont annoncés comme étant en lecture seule et non destructifs, avec les annotations suivantes : -- `readOnlyHint: true` — l’outil ne modifie aucun état. -- `destructiveHint: false` — l’outil n’a aucun effet de bord destructeur. -- `idempotentHint: true` — des appels répétés avec les mêmes arguments renvoient des résultats équivalents. -- `openWorldHint: false` — l’outil opère sur votre documentation indexée plutôt que sur le web ouvert. +- `readOnlyHint: true`—l’outil ne modifie aucun état. +- `destructiveHint: false`—l’outil n’a aucun effet de bord destructeur. +- `idempotentHint: true`—des appels répétés avec les mêmes arguments renvoient des résultats équivalents. +- `openWorldHint: false`—l’outil opère sur votre documentation indexée plutôt que sur le web ouvert. Les clients MCP peuvent utiliser ces annotations pour présenter des informations de sécurité aux utilisateurs ou pour permettre aux outils en lecture seule de s’exécuter sans approbation explicite. diff --git a/fr/guides/seo.mdx b/fr/guides/seo.mdx index 50db71b0f3..2d6978bc79 100644 --- a/fr/guides/seo.mdx +++ b/fr/guides/seo.mdx @@ -171,7 +171,7 @@ Vérifiez-le mensuellement et priorisez les pages avec beaucoup d'impressions ma -Il n'y a pas de longueur idéale universelle. Les pages devraient être suffisamment longues pour couvrir le sujet de manière complète et suffisamment courtes pour rester ciblées. Un guide de démarrage peut faire 800 mots. Une référence API détaillée peut en faire 3 000. Ce qui compte, c'est que les utilisateurs puissent atteindre leur objectif depuis la page — s'ils doivent la quitter pour trouver des informations complémentaires, la page est probablement trop légère. En général, les pages de moins de 300 mots ont du mal à se classer pour les requêtes concurrentielles car elles ne démontrent pas de profondeur thématique. +Il n'y a pas de longueur idéale universelle. Les pages devraient être suffisamment longues pour couvrir le sujet de manière complète et suffisamment courtes pour rester ciblées. Un guide de démarrage peut faire 800 mots. Une référence API détaillée peut en faire 3 000. Ce qui compte, c'est que les utilisateurs puissent atteindre leur objectif depuis la page—s'ils doivent la quitter pour trouver des informations complémentaires, la page est probablement trop légère. En général, les pages de moins de 300 mots ont du mal à se classer pour les requêtes concurrentielles car elles ne démontrent pas de profondeur thématique. @@ -183,14 +183,14 @@ Dans [Google Search Console](https://search.google.com/search-console), allez da -Mettez à jour la documentation chaque fois que le produit change — la précision est le signal le plus important. Pour le SEO spécifiquement, les pages qui n'ont pas été modifiées depuis plus d'un an peuvent bénéficier d'une révision pour ajouter des informations manquantes, mettre à jour les exemples et développer les sections légères. Utilisez Google Search Console pour prioriser : les pages qui perdent du trafic ou qui descendent en position sont candidates à un rafraîchissement. +Mettez à jour la documentation chaque fois que le produit change—la précision est le signal le plus important. Pour le SEO spécifiquement, les pages qui n'ont pas été modifiées depuis plus d'un an peuvent bénéficier d'une révision pour ajouter des informations manquantes, mettre à jour les exemples et développer les sections légères. Utilisez Google Search Console pour prioriser : les pages qui perdent du trafic ou qui descendent en position sont candidates à un rafraîchissement. -SEO (Search Engine Optimization) se concentre sur le classement dans les moteurs de recherche traditionnels comme Google et Bing. GEO (Generative Engine Optimization) se concentre sur le fait d'être cité par des outils alimentés par l'IA comme ChatGPT, Perplexity et Google AI Overviews. Les fondamentaux se recoupent — un contenu précis et bien structuré fonctionne bien dans les deux — mais le GEO a quelques pratiques supplémentaires concernant le formatage pour l'analyse par l'IA. Consultez le [guide GEO](/fr/guides/geo) pour plus de détails. +SEO (Search Engine Optimization) se concentre sur le classement dans les moteurs de recherche traditionnels comme Google et Bing. GEO (Generative Engine Optimization) se concentre sur le fait d'être cité par des outils alimentés par l'IA comme ChatGPT, Perplexity et Google AI Overviews. Les fondamentaux se recoupent—un contenu précis et bien structuré fonctionne bien dans les deux—mais le GEO a quelques pratiques supplémentaires concernant le formatage pour l'analyse par l'IA. Consultez le [guide GEO](/fr/guides/geo) pour plus de détails. -Mintlify gère les fondations techniques : génération du sitemap, HTML sémantique, balises canoniques, génération des balises meta et optimisation mobile. Ce que Mintlify ne peut pas faire pour vous, c'est rédiger de meilleurs titres, faire de la recherche de mots-clés, construire des liens internes ou développer du contenu léger — cela nécessite des décisions éditoriales. La [référence de configuration SEO](/fr/optimize/seo) couvre tout ce que vous pouvez contrôler via `docs.json` et le frontmatter de page. +Mintlify gère les fondations techniques : génération du sitemap, HTML sémantique, balises canoniques, génération des balises meta et optimisation mobile. Ce que Mintlify ne peut pas faire pour vous, c'est rédiger de meilleurs titres, faire de la recherche de mots-clés, construire des liens internes ou développer du contenu léger—cela nécessite des décisions éditoriales. La [référence de configuration SEO](/fr/optimize/seo) couvre tout ce que vous pouvez contrôler via `docs.json` et le frontmatter de page. diff --git a/fr/optimize/seo.mdx b/fr/optimize/seo.mdx index 2bd0a4f05e..2eae81e9d1 100644 --- a/fr/optimize/seo.mdx +++ b/fr/optimize/seo.mdx @@ -368,9 +368,9 @@ Content-Signal: ai-train=yes, search=yes, ai-input=yes Les signaux par défaut activent votre documentation pour : -- `ai-train=yes` — Entraînement de modèles d'IA. -- `search=yes` — Création d'index de recherche. -- `ai-input=yes` — Génération de réponses par IA, y compris la génération augmentée par récupération et les assistants IA. +- `ai-train=yes`—Entraînement de modèles d'IA. +- `search=yes`—Création d'index de recherche. +- `ai-input=yes`—Génération de réponses par IA, y compris la génération augmentée par récupération et les assistants IA. Ces valeurs par défaut aident les outils d'IA comme ChatGPT, Claude et Perplexity à découvrir et à citer votre documentation. Pour modifier les signaux, [ajoutez un `robots.txt` personnalisé](#custom-sitemaps-and-robotstxt-files) à la racine de votre projet. Mintlify sert les fichiers personnalisés tels quels, sans les directives Content-Signal par défaut. @@ -439,8 +439,8 @@ Utilisez cette option lorsque vous souhaitez conserver un déploiement en ligne Ce paramètre fonctionne en complément d’autres contrôles d’indexation : -- **`noindex` par page** — Le `noindex: true` au niveau d’une page dans le frontmatter continue de s’appliquer lorsque le paramètre au niveau du projet est désactivé. Le paramètre au niveau du projet remplace les réglages par page lorsqu’il est activé, et toutes les pages sont alors traitées comme `noindex`. -- **`robots.txt` personnalisé** — Si vous avez un [`robots.txt` personnalisé](#custom-sitemaps-and-robotstxt-files) à la racine de votre projet, Mintlify le sert tel quel. Le paramètre au niveau du projet ne remplace pas un `robots.txt` personnalisé : mettez-le à jour ou supprimez-le séparément si vous souhaitez que les règles pour les robots d’exploration soient cohérentes. +- **`noindex` par page**—Le `noindex: true` au niveau d’une page dans le frontmatter continue de s’appliquer lorsque le paramètre au niveau du projet est désactivé. Le paramètre au niveau du projet remplace les réglages par page lorsqu’il est activé, et toutes les pages sont alors traitées comme `noindex`. +- **`robots.txt` personnalisé**—Si vous avez un [`robots.txt` personnalisé](#custom-sitemaps-and-robotstxt-files) à la racine de votre projet, Mintlify le sert tel quel. Le paramètre au niveau du projet ne remplace pas un `robots.txt` personnalisé : mettez-le à jour ou supprimez-le séparément si vous souhaitez que les règles pour les robots d’exploration soient cohérentes.
## Bonnes pratiques SEO diff --git a/fr/organize/settings-structure.mdx b/fr/organize/settings-structure.mdx index 520e799623..bb72aa74d1 100644 --- a/fr/organize/settings-structure.mdx +++ b/fr/organize/settings-structure.mdx @@ -376,23 +376,23 @@ Le menu contextuel donne aux utilisateurs un accès rapide aux outils IA et aux Actions disponibles dans le menu contextuel. La première option du tableau apparaît comme action par défaut. Options intégrées : - - `"add-mcp"` — Ajouter votre serveur MCP à la configuration de l'utilisateur - - `"aistudio"` — Envoyer la page actuelle à Google AI Studio - - `"assistant"` — Ouvrir l'assistant IA avec la page actuelle comme contexte - - `"copy"` — Copier la page actuelle au format Markdown dans le presse-papiers - - `"chatgpt"` — Envoyer la page actuelle à ChatGPT - - `"claude"` — Envoyer la page actuelle à Claude - - `"cursor"` — Installer votre serveur MCP hébergé dans Cursor - - `"devin"` — Envoyer la page actuelle à Devin - - `"devin-mcp"` — Installer votre serveur MCP hébergé dans Devin - - `"download-pdf"` — Télécharger la page actuelle au format PDF - - `"download-spec"` — Télécharger les spécifications OpenAPI du déploiement (un seul fichier, ou compressées en zip s'il y en a plusieurs) - - `"grok"` — Envoyer la page actuelle à Grok - - `"mcp"` — Copier l'URL de votre serveur MCP dans le presse-papiers - - `"perplexity"` — Envoyer la page actuelle à Perplexity - - `"view"` — Afficher la page actuelle au format Markdown dans un nouvel onglet - - `"vscode"` — Installer votre serveur MCP hébergé dans VS Code - - `"devin-desktop"` — Ouvrir Devin Desktop avec la page actuelle comme contexte + - `"add-mcp"`—Ajouter votre serveur MCP à la configuration de l'utilisateur + - `"aistudio"`—Envoyer la page actuelle à Google AI Studio + - `"assistant"`—Ouvrir l'assistant IA avec la page actuelle comme contexte + - `"copy"`—Copier la page actuelle au format Markdown dans le presse-papiers + - `"chatgpt"`—Envoyer la page actuelle à ChatGPT + - `"claude"`—Envoyer la page actuelle à Claude + - `"cursor"`—Installer votre serveur MCP hébergé dans Cursor + - `"devin"`—Envoyer la page actuelle à Devin + - `"devin-mcp"`—Installer votre serveur MCP hébergé dans Devin + - `"download-pdf"`—Télécharger la page actuelle au format PDF + - `"download-spec"`—Télécharger les spécifications OpenAPI du déploiement (un seul fichier, ou compressées en zip s'il y en a plusieurs) + - `"grok"`—Envoyer la page actuelle à Grok + - `"mcp"`—Copier l'URL de votre serveur MCP dans le presse-papiers + - `"perplexity"`—Envoyer la page actuelle à Perplexity + - `"view"`—Afficher la page actuelle au format Markdown dans un nouvel onglet + - `"vscode"`—Installer votre serveur MCP hébergé dans VS Code + - `"devin-desktop"`—Ouvrir Devin Desktop avec la page actuelle comme contexte Définissez des options personnalisées sous forme d'objets : @@ -410,9 +410,9 @@ Le menu contextuel donne aux utilisateurs un accès rapide aux outils IA et aux Destination du lien. Peut être une chaîne URL ou un objet avec `base` et des paramètres `query` facultatifs. Valeurs de substitution disponibles : - - `$page` — Contenu de la page actuelle - - `$path` — Chemin de la page actuelle - - `$mcp` — URL du serveur MCP + - `$page`—Contenu de la page actuelle + - `$path`—Chemin de la page actuelle + - `$mcp`—URL du serveur MCP diff --git a/zh/ai/model-context-protocol.mdx b/zh/ai/model-context-protocol.mdx index b58ef529a7..9c8e82955a 100644 --- a/zh/ai/model-context-protocol.mdx +++ b/zh/ai/model-context-protocol.mdx @@ -188,10 +188,10 @@ Mintlify 在 `/.well-known/mcp` 托管一个发现文档,便于智能体和工 内置的搜索和查询文档文件系统工具会以只读且非破坏性的方式对外公布,并带有以下注解: -- `readOnlyHint: true` — 该工具不会修改任何状态。 -- `destructiveHint: false` — 该工具没有破坏性副作用。 -- `idempotentHint: true` — 使用相同参数重复调用会返回等价的结果。 -- `openWorldHint: false` — 该工具针对你已索引的文档进行操作,而非开放的互联网。 +- `readOnlyHint: true`—该工具不会修改任何状态。 +- `destructiveHint: false`—该工具没有破坏性副作用。 +- `idempotentHint: true`—使用相同参数重复调用会返回等价的结果。 +- `openWorldHint: false`—该工具针对你已索引的文档进行操作,而非开放的互联网。 MCP 客户端可以利用这些注解向用户呈现工具的安全性信息,或允许只读工具在无需显式批准的情况下运行。 diff --git a/zh/create/changelogs.mdx b/zh/create/changelogs.mdx index 990289109e..26db3e00af 100644 --- a/zh/create/changelogs.mdx +++ b/zh/create/changelogs.mdx @@ -133,7 +133,7 @@ RSS 源条目只包含纯 Markdown,会排除组件、代码和 HTML 元素。 RSS 源可与 Slack、电子邮件或其他订阅工具集成,用于通知用户产品更新。可选方案包括: * [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) -* 通过 Zapier 的 [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) +* 通过 Zapier 的 [email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) * 如 [Readybot](https://readybot.io) 或 [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot) 等 Discord 机器人 为便于发现 RSS 源,你可以在页面顶部显示一个链接到该源的 RSS icon 按钮。在页面 frontmatter 中添加 `rss: true`: diff --git a/zh/optimize/seo.mdx b/zh/optimize/seo.mdx index 66be20d4e5..337610e288 100644 --- a/zh/optimize/seo.mdx +++ b/zh/optimize/seo.mdx @@ -366,9 +366,9 @@ Content-Signal: ai-train=yes, search=yes, ai-input=yes 默认信号会让你的文档启用以下用途: -- `ai-train=yes` — 训练 AI 模型。 -- `search=yes` — 构建搜索索引。 -- `ai-input=yes` — 生成 AI 回答,包括检索增强生成(RAG)和 AI 助手。 +- `ai-train=yes`—训练 AI 模型。 +- `search=yes`—构建搜索索引。 +- `ai-input=yes`—生成 AI 回答,包括检索增强生成(RAG)和 AI 助手。 这些默认值有助于 ChatGPT、Claude、Perplexity 等 AI 工具发现并引用你的文档。要更改这些信号,请在项目根目录[添加自定义 `robots.txt`](#custom-sitemaps-and-robotstxt-files)。Mintlify 会按原样提供自定义文件,不会包含默认的 Content-Signal 指令。 @@ -436,8 +436,8 @@ noindex: true 此设置与其他索引控制配合使用: -- **按页 `noindex`** — 当项目级设置关闭时,frontmatter 中的 `noindex: true` 仍然生效。项目级设置开启时会覆盖按页设置,所有页面都按 `noindex` 处理。 -- **自定义 `robots.txt`** — 如果你在项目根目录提供了[自定义 `robots.txt`](#custom-sitemaps-and-robotstxt-files),Mintlify 会原样提供该文件。项目级设置不会替换自定义 `robots.txt`,因此如果需要让爬虫规则保持一致,请单独更新或删除你的自定义文件。 +- **按页 `noindex`**—当项目级设置关闭时,frontmatter 中的 `noindex: true` 仍然生效。项目级设置开启时会覆盖按页设置,所有页面都按 `noindex` 处理。 +- **自定义 `robots.txt`**—如果你在项目根目录提供了[自定义 `robots.txt`](#custom-sitemaps-and-robotstxt-files),Mintlify 会原样提供该文件。项目级设置不会替换自定义 `robots.txt`,因此如果需要让爬虫规则保持一致,请单独更新或删除你的自定义文件。
## SEO 最佳实践 diff --git a/zh/organize/settings-structure.mdx b/zh/organize/settings-structure.mdx index 92d65928df..3798d5da2b 100644 --- a/zh/organize/settings-structure.mdx +++ b/zh/organize/settings-structure.mdx @@ -376,22 +376,22 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 上下文菜单中可用的操作。数组中的第一个选项显示为默认操作。 内置选项: - - `"add-mcp"` — 将你的 MCP 服务器添加到用户的配置中 - - `"aistudio"` — 将当前页面发送到 Google AI Studio - - `"assistant"` — 以当前页面为上下文打开 AI 助手 - - `"copy"` — 将当前页面复制为 Markdown 到剪贴板 - - `"chatgpt"` — 将当前页面发送到 ChatGPT - - `"claude"` — 将当前页面发送到 Claude - - `"cursor"` — 在 Cursor 中安装你托管的 MCP 服务器 - - `"devin"` — 将当前页面发送到 Devin - - `"devin-mcp"` — 在 Devin 中安装你托管的 MCP 服务器 - - `"download-pdf"` — 将当前页面下载为 PDF - - `"grok"` — 将当前页面发送到 Grok - - `"mcp"` — 将你的 MCP 服务器 URL 复制到剪贴板 - - `"perplexity"` — 将当前页面发送到 Perplexity - - `"view"` — 在新标签页中以 Markdown 查看当前页面 - - `"vscode"` — 在 VS Code 中安装你托管的 MCP 服务器 - - `"devin-desktop"` — 以当前页面为上下文打开 Devin Desktop + - `"add-mcp"`—将你的 MCP 服务器添加到用户的配置中 + - `"aistudio"`—将当前页面发送到 Google AI Studio + - `"assistant"`—以当前页面为上下文打开 AI 助手 + - `"copy"`—将当前页面复制为 Markdown 到剪贴板 + - `"chatgpt"`—将当前页面发送到 ChatGPT + - `"claude"`—将当前页面发送到 Claude + - `"cursor"`—在 Cursor 中安装你托管的 MCP 服务器 + - `"devin"`—将当前页面发送到 Devin + - `"devin-mcp"`—在 Devin 中安装你托管的 MCP 服务器 + - `"download-pdf"`—将当前页面下载为 PDF + - `"grok"`—将当前页面发送到 Grok + - `"mcp"`—将你的 MCP 服务器 URL 复制到剪贴板 + - `"perplexity"`—将当前页面发送到 Perplexity + - `"view"`—在新标签页中以 Markdown 查看当前页面 + - `"vscode"`—在 VS Code 中安装你托管的 MCP 服务器 + - `"devin-desktop"`—以当前页面为上下文打开 Devin Desktop 将自定义选项定义为对象: @@ -409,9 +409,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 链接目标。可以是 URL 字符串或带有 `base` 和可选 `query` 参数的对象。 可用占位符值: - - `$page` — 当前页面内容 - - `$path` — 当前页面路径 - - `$mcp` — MCP 服务器 URL + - `$page`—当前页面内容 + - `$path`—当前页面路径 + - `$mcp`—MCP 服务器 URL From 497558fb4273e2a42a27767595f1e7f00a21f575 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Jun 2026 09:23:43 -0700 Subject: [PATCH 3/4] Apply suggestion from @ethanpalm --- create/changelogs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/create/changelogs.mdx b/create/changelogs.mdx index 7ac6230afb..ea958236a1 100644 --- a/create/changelogs.mdx +++ b/create/changelogs.mdx @@ -136,7 +136,7 @@ RSS feed entries contain pure Markdown only. They exclude components, code, and RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include: * [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) -* [email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier +* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier * Discord bots like [Readybot](https://readybot.io) or [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot) To make the RSS feed discoverable, you can display an RSS icon button that links to the feed at the top of the page. Add `rss: true` to the page frontmatter: From a148205f79c806db7c8b4fd2ecb6e8ca35cf1b14 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Jun 2026 09:24:29 -0700 Subject: [PATCH 4/4] Apply suggestion from @ethanpalm --- advanced-support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advanced-support.mdx b/advanced-support.mdx index 9d072337c5..ba82ff09d2 100644 --- a/advanced-support.mdx +++ b/advanced-support.mdx @@ -11,7 +11,7 @@ Mintlify offers three support tiers. The right tier depends on the level of comm | | Standard | Advanced Slack | Dedicated CSM | |---|---|---|---| | **Tier** | 1 (included) | 2 (add-on) | 3 (add-on) | -| **How issues reach us** | email or dashboard | AI routing from Slack | CSM escalates from Slack | +| **How issues reach us** | Email or dashboard | AI routing from Slack | CSM escalates from Slack | | **Response time targets** | Best effort | P0–P3 | P0–P3 | | **Named contact** | No | No | Yes | | **Monthly check-ins** | No | No | Yes |