diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index 58fb21916..0632beccc 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -56,9 +56,27 @@ Both `llms.txt` and `llms-full.txt` list pages from your default language and de This structured approach allows LLMs to efficiently process your documentation at a high level and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches. - Automatically generated `llms.txt` index files cannot exceed 100,000 characters. For large documentation sites, Mintlify splits the index into linked files under `/_llms/` so agents can discover every page without loading one oversized file. This limit does not apply to `llms-full.txt`. + Any single `llms.txt` index file cannot exceed 100,000 characters. When the full index would exceed that budget, Mintlify splits it into scoped child index files instead of dropping pages. Every page remains reachable through the split indexes. This limit does not apply to `llms-full.txt`. +### Scoped indexes for large sites + +When the full index exceeds the character budget, Mintlify partitions your documentation into scoped indexes: + +- Each scoped index is served at `/_llms/.md`, where `` identifies the subtree it covers. +- Mintlify first splits by navigation subtree (groups, tabs, and other structural containers in your `docs.json`). Large flat sections that have no substructure are then split by URL path segment so no single index exceeds the budget. +- The root `llms.txt` file adds an `## Indexes` section that lists every scoped index directly reachable from the root, with a breadcrumb, a unique page count, and each index's description. This directory is preceded by an instruction telling AI tools to follow the links recursively until they reach documentation pages. +- Scoped indexes follow the same format as the root file, so a scoped index can itself contain another `## Indexes` section. AI tools should recurse through those links to reach every page. + +```mdx Example Indexes section in llms.txt +> Follow every linked index under `/_llms/` recursively until you reach documentation pages. + +## Indexes + +- [API reference (128 pages)](https://example.com/_llms/api-reference.md): REST endpoints, authentication, and webhooks. +- [Guides / Integrations (42 pages)](https://example.com/_llms/guides/integrations.md): Third-party integration walkthroughs. +``` + If you use a reverse proxy or maintain a path allowlist, forward `/_llms/*` in addition to `/llms.txt` so agents can follow the generated index links. For documentation hosted at a base path, forward `/_llms/*` instead. Mintlify-managed custom domains do not require additional configuration. See [Reverse proxy](/deploy/reverse-proxy#routing-configuration) for routing guidance. ```mdx Example llms.txt diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index c6ac44645..447d482f7 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -58,9 +58,27 @@ Tanto `llms.txt` como `llms-full.txt` listan las páginas de tu idioma predeterm Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA. - Los archivos de índice `llms.txt` generados automáticamente no pueden superar los 100.000 caracteres. Para sitios de documentación grandes, Mintlify divide el índice en archivos enlazados bajo `/_llms/` para que los agentes puedan descubrir cada página sin cargar un único archivo demasiado grande. Este límite no se aplica a `llms-full.txt`. + Ningún archivo de índice `llms.txt` puede superar los 100.000 caracteres. Cuando el índice completo excede ese presupuesto, Mintlify lo divide en archivos de índice secundarios con alcance acotado en lugar de descartar páginas. Todas las páginas siguen siendo accesibles a través de los índices divididos. Este límite no se aplica a `llms-full.txt`. +### Índices con alcance para sitios grandes + +Cuando el índice completo supera el presupuesto de caracteres, Mintlify particiona tu documentación en índices con alcance acotado: + +- Cada índice con alcance se sirve en `/_llms/.md`, donde `` identifica el subárbol que cubre. +- Mintlify divide primero por subárbol de navegación (grupos, pestañas y otros contenedores estructurales en tu `docs.json`). Las secciones planas grandes que no tienen subestructura se dividen a continuación por segmento de ruta de URL, de modo que ningún índice único supere el presupuesto. +- El archivo `llms.txt` raíz añade una sección `## Indexes` que enumera cada índice con alcance directamente accesible desde la raíz, con una migaja de pan, el recuento de páginas únicas y la descripción de cada índice. Este directorio va precedido de una instrucción que indica a las herramientas de IA que sigan los enlaces de forma recursiva hasta llegar a las páginas de documentación. +- Los índices con alcance siguen el mismo formato que el archivo raíz, por lo que un índice con alcance puede contener a su vez otra sección `## Indexes`. Las herramientas de IA deben recorrer esos enlaces de forma recursiva para llegar a todas las páginas. + +```mdx Ejemplo de sección Indexes en llms.txt +> Follow every linked index under `/_llms/` recursively until you reach documentation pages. + +## Indexes + +- [API reference (128 pages)](https://example.com/_llms/api-reference.md): REST endpoints, authentication, and webhooks. +- [Guides / Integrations (42 pages)](https://example.com/_llms/guides/integrations.md): Third-party integration walkthroughs. +``` + Si utilizas un proxy inverso o mantienes una lista de rutas permitidas, reenvía `/_llms/*` además de `/llms.txt` para que los agentes puedan seguir los enlaces del índice generado. Para documentación alojada en una ruta base, reenvía `/_llms/*` en su lugar. Los dominios personalizados gestionados por Mintlify no requieren configuración adicional. Consulta [Proxy inverso](/es/deploy/reverse-proxy#routing-configuration) para obtener orientación sobre el enrutamiento. ```mdx Example llms.txt diff --git a/fr/ai/llmstxt.mdx b/fr/ai/llmstxt.mdx index 0b904befc..c12f8417e 100644 --- a/fr/ai/llmstxt.mdx +++ b/fr/ai/llmstxt.mdx @@ -58,9 +58,27 @@ Les fichiers `llms.txt` et `llms-full.txt` répertorient les pages de votre lang Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l'IA. - Les fichiers d'index `llms.txt` générés automatiquement ne peuvent pas dépasser 100 000 caractères. Pour les sites de documentation volumineux, Mintlify scinde l'index en fichiers liés sous `/_llms/` afin que les agents puissent découvrir chaque page sans charger un seul fichier trop volumineux. Cette limite ne s'applique pas à `llms-full.txt`. + Aucun fichier d'index `llms.txt` ne peut dépasser 100 000 caractères. Lorsque l'index complet dépasserait ce budget, Mintlify le divise en fichiers d'index enfants scopés au lieu de supprimer des pages. Toutes les pages restent accessibles via les index divisés. Cette limite ne s'applique pas à `llms-full.txt`. +### Index scopés pour les sites volumineux + +Lorsque l'index complet dépasse le budget de caractères, Mintlify partitionne votre documentation en index scopés : + +- Chaque index scopé est servi à l'adresse `/_llms/.md`, où `` identifie le sous-arbre qu'il couvre. +- Mintlify divise d'abord par sous-arbre de navigation (groupes, onglets et autres conteneurs structurels de votre `docs.json`). Les grandes sections plates sans sous-structure sont ensuite divisées par segment de chemin d'URL, afin qu'aucun index ne dépasse le budget. +- Le fichier `llms.txt` racine ajoute une section `## Indexes` qui répertorie chaque index scopé accessible directement depuis la racine, avec un fil d'Ariane, le nombre de pages uniques et la description de chaque index. Ce répertoire est précédé d'une instruction indiquant aux outils d'IA de suivre les liens de manière récursive jusqu'aux pages de documentation. +- Les index scopés suivent le même format que le fichier racine, de sorte qu'un index scopé peut lui-même contenir une autre section `## Indexes`. Les outils d'IA doivent parcourir ces liens de manière récursive pour atteindre chaque page. + +```mdx Exemple de section Indexes dans llms.txt +> Follow every linked index under `/_llms/` recursively until you reach documentation pages. + +## Indexes + +- [API reference (128 pages)](https://example.com/_llms/api-reference.md): REST endpoints, authentication, and webhooks. +- [Guides / Integrations (42 pages)](https://example.com/_llms/guides/integrations.md): Third-party integration walkthroughs. +``` + Si vous utilisez un reverse proxy ou maintenez une liste d'autorisation de chemins, transférez `/_llms/*` en plus de `/llms.txt` pour que les agents puissent suivre les liens de l'index généré. Pour une documentation hébergée sous un chemin de base, transférez `/_llms/*` à la place. Les domaines personnalisés gérés par Mintlify ne nécessitent aucune configuration supplémentaire. Consultez [Reverse proxy](/fr/deploy/reverse-proxy#routing-configuration) pour des conseils de routage. ```mdx Example llms.txt diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index 354db76cc..ca160adf8 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -58,9 +58,27 @@ X-Llms-Txt: /llms.txt 这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档，并为用户查询定位相关内容，从而提升 AI 辅助文档搜索的准确性和速度。 - 自动生成的 `llms.txt` 索引文件不能超过 100,000 个字符。对于大型文档站点，Mintlify 会将索引拆分为位于 `/_llms/` 下的多个链接文件，使代理无需加载单个超大文件即可发现所有页面。此限制不适用于 `llms-full.txt`。 + 任何单个 `llms.txt` 索引文件都不能超过 100,000 个字符。当完整索引会超出该预算时，Mintlify 会将其拆分为按范围划分的子索引文件，而不是丢弃页面。所有页面都仍可通过拆分后的索引访问。此限制不适用于 `llms-full.txt`。 +### 大型站点的按范围索引 + +当完整索引超出字符预算时，Mintlify 会将你的文档划分为按范围划分的索引： + +- 每个按范围划分的索引都提供在 `/_llms/.md`，其中 `` 标识其所覆盖的子树。 +- Mintlify 首先按导航子树（`docs.json` 中的分组、标签页以及其他结构性容器）进行拆分。对于没有子结构的大型扁平部分，则再按 URL 路径段进行拆分，以使任何单个索引都不超过预算。 +- 根 `llms.txt` 文件会新增一个 `## Indexes` 部分，列出可从根直接访问的每个按范围划分的索引，包含面包屑、唯一页面数量以及每个索引的描述。该目录之前会附上一条说明，指示 AI 工具递归地跟随链接，直到到达文档页面。 +- 按范围划分的索引与根文件采用相同的格式，因此某个按范围划分的索引本身也可以包含另一个 `## Indexes` 部分。AI 工具应递归遍历这些链接以到达每个页面。 + +```mdx llms.txt 中 Indexes 部分示例 +> Follow every linked index under `/_llms/` recursively until you reach documentation pages. + +## Indexes + +- [API reference (128 pages)](https://example.com/_llms/api-reference.md): REST endpoints, authentication, and webhooks. +- [Guides / Integrations (42 pages)](https://example.com/_llms/guides/integrations.md): Third-party integration walkthroughs. +``` + 如果你使用反向代理或维护路径允许列表，请在转发 `/llms.txt` 的同时转发 `/_llms/*`，以便代理能够跟随生成的索引链接。对于托管在基础路径下的文档，改为转发 `/_llms/*`。由 Mintlify 管理的自定义域名无需额外配置。有关路由指引，请参见[反向代理](/zh/deploy/reverse-proxy#routing-configuration)。 ```mdx Example llms.txt