Guía de documentación

Este directorio es responsable de la autoría de documentación, las reglas de enlaces de Mintlify y la política de i18n de la documentación.

Reglas de Mintlify

• La documentación se aloja en Mintlify (https://docs.openclaw.ai).
• Los enlaces internos de documentación en docs/**/*.md deben permanecer relativos a la raíz, sin sufijo .md ni .mdx (ejemplo: [Config](/gateway/configuration)).
• Las referencias cruzadas de secciones deben usar anclas en rutas relativas a la raíz (ejemplo: [Hooks](/gateway/configuration-reference#hooks)).
• Los encabezados de documentación deben evitar las rayas y los apóstrofos porque la generación de anclas de Mintlify es frágil en esos casos.
• El README y otros documentos renderizados por GitHub deben mantener URL absolutas de la documentación para que los enlaces funcionen fuera de Mintlify.
• El contenido de la documentación debe mantenerse genérico: sin nombres de dispositivos personales, nombres de host ni rutas locales; usa marcadores de posición como user@gateway-host.

Reglas de contenido de documentación

• Para documentación, texto de UI y listas de selección, ordena los servicios/proveedores alfabéticamente, salvo que la sección describa explícitamente el orden de ejecución o el orden de detección automática.
• Mantén la nomenclatura de los plugins incluidos coherente con las reglas terminológicas de plugins de todo el repositorio en el AGENTS.md raíz.

Documentación interna

• La documentación privada de operadores de larga duración debe estar en ~/Projects/manager/docs/.
• La documentación interna local del repositorio para borradores/espejos puede vivir bajo el docs/internal/ ignorado.
• Nunca agregues páginas docs/internal/** a la navegación de docs/docs.json ni las enlaces desde la documentación pública.
• scripts/docs-sync-publish.mjs excluye y elimina docs/internal/** del repositorio público de publicación openclaw/docs si una página se fuerza a agregar más tarde.
• La documentación interna puede mencionar rutas del repositorio, nombres de aplicaciones privadas, nombres de elementos de 1Password y manuales operativos, pero nunca debe incluir valores secretos.

Edición de la tarjeta de puntuación de madurez

taxonomy.yaml y qa/maturity-scores.yaml son las entradas fuente; la documentación de madurez generada bajo docs/maturity/ son proyecciones y no deben editarse a mano para puntuación, LTS, taxonomía, perfil de QA ni tablas de evidencia. scripts/qa/render-maturity-docs.ts es responsable de la generación; usa pnpm maturity:render para actualizar la documentación confirmada y pnpm maturity:check para verificarla. .github/workflows/maturity-scorecard.yml renderiza vistas previas de artefactos y puede abrir PRs de documentación generada; .github/workflows/openclaw-release-checks.yml lo despacha para QA de releases. Mantén los datos deterministas de qa-evidence.json.scorecard en los artefactos de GitHub Actions salvo que un responsable de mantenimiento pida explícitamente una proyección saneada confirmada. Las anulaciones humanas deben cambiar el estado fuente en un PR y explicar el motivo junto con evidencia pública o redactada.

i18n de documentación

• La documentación en idiomas extranjeros no se mantiene en este repositorio. La salida de publicación generada vive en el repositorio separado openclaw/docs (a menudo clonado localmente como ../openclaw-docs).
• No agregues ni edites documentación localizada bajo docs/<locale>/** aquí.
• Trata la documentación en inglés de este repositorio y los archivos de glosario como la fuente de verdad.
• Pipeline: actualiza la documentación en inglés aquí, actualiza docs/.i18n/glossary.<locale>.json según sea necesario y luego deja que la sincronización del repositorio de publicación y scripts/docs-i18n se ejecuten en openclaw/docs.
• Antes de volver a ejecutar scripts/docs-i18n, agrega entradas de glosario para cualquier término técnico nuevo, título de página o etiqueta corta de navegación que deba permanecer en inglés o usar una traducción fija.
• pnpm docs:check-i18n-glossary es la protección para títulos de documentación en inglés modificados y etiquetas cortas de documentación interna.
• La memoria de traducción vive en los archivos generados docs/.i18n/*.tm.jsonl en el repositorio de publicación.
• Consulta docs/.i18n/README.md.