From d8dd8f7484c4095cb4a63da316167652b80e9493 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 11 Mar 2026 18:13:30 +0000 Subject: [PATCH] docs: document 300-character description truncation in llms.txt Generated-By: mintlify-agent --- ai/llmstxt.mdx | 2 +- es/ai/llmstxt.mdx | 2 +- fr/ai/llmstxt.mdx | 2 +- zh/ai/llmstxt.mdx | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index d3d64e10a..9e0371970 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -28,7 +28,7 @@ An `llms.txt` file is a plain Markdown file that contains: The `llms.txt` file lists your pages alphabetically in the order they appear in your repository, starting from the root directory. -Each page's description comes from the `description` field in its frontmatter. For API reference pages, the description also includes the specification information from the `openapi` or `api` frontmatter field. Pages without a `description` field appear in the `llms.txt` file without a description. +Each page's description comes from the `description` field in its frontmatter. Descriptions longer than 300 characters are truncated to the first 300 characters. For API reference pages, the description also includes the specification information from the `openapi` or `api` frontmatter field. Pages without a `description` field appear in the `llms.txt` file without a description. ```mdx Example llms.txt # Site title diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index bf195ccd4..da77f93a9 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -30,7 +30,7 @@ Un archivo `llms.txt` es un archivo Markdown sin formato que contiene: El archivo `llms.txt` lista tus páginas alfabéticamente en el orden en que aparecen en tu repositorio, comenzando desde el directorio raíz. -La descripción de cada página proviene del campo `description` en su frontmatter. Para las páginas de referencia de API, la descripción también incluye la información de la especificación del campo `openapi` o `api` del frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción. +La descripción de cada página proviene del campo `description` en su frontmatter. Las descripciones de más de 300 caracteres se truncan a los primeros 300 caracteres. Para las páginas de referencia de API, la descripción también incluye la información de la especificación del campo `openapi` o `api` del frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción. 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. diff --git a/fr/ai/llmstxt.mdx b/fr/ai/llmstxt.mdx index 50c6b4342..e1faad9ac 100644 --- a/fr/ai/llmstxt.mdx +++ b/fr/ai/llmstxt.mdx @@ -30,7 +30,7 @@ Un fichier `llms.txt` est un simple fichier Markdown qui contient : Le fichier `llms.txt` répertorie vos pages par ordre alphabétique selon leur emplacement dans votre référentiel, en commençant au répertoire racine. -La description de chaque page provient du champ `description` de son frontmatter. Pour les pages de référence d'API, la description inclut également les informations de spécification issues du champ de frontmatter `openapi` ou `api`. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description. +La description de chaque page provient du champ `description` de son frontmatter. Les descriptions de plus de 300 caractères sont tronquées aux 300 premiers caractères. Pour les pages de référence d'API, la description inclut également les informations de spécification issues du champ de frontmatter `openapi` ou `api`. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description. ```mdx Example llms.txt # Titre du site diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index 915b1d5df..efdd88ca7 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -30,7 +30,7 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件，列出文 `llms.txt` 文件会按照页面在存储库中的位置，以字母顺序列出，从根目录开始。 -每个页面的说明来自其 frontmatter 中的 `description` 字段。对于 API 参考页面，说明中还会包含来自 `openapi` 或 `api` frontmatter 字段的规范信息。没有 `description` 字段的页面将在 `llms.txt` 中显示，但不含说明。 +每个页面的说明来自其 frontmatter 中的 `description` 字段。超过 300 个字符的说明会被截断至前 300 个字符。对于 API 参考页面，说明中还会包含来自 `openapi` 或 `api` frontmatter 字段的规范信息。没有 `description` 字段的页面将在 `llms.txt` 中显示，但不含说明。 ```mdx Example llms.txt # 站点标题