Saltar a contenido

Cómo ejecutar los quality gates documentales de Gastro

Este runbook valida que la documentación del workspace siga alineada con el código y con sus generadores.

1. Ejecutar la auditoría del workspace

bash apps/gastro/scripts/audit_docs_consistency.sh

El script valida:

  • longitud de apps/gastro/AGENTS.md
  • drift en referencias backend generadas
  • drift en referencias frontend generadas
  • drift en llms-full.txt
  • presencia de strings documentales obsoletos conocidos

2. Requisitos previos

  • backend con .venv listo si vas a regenerar referencias backend
  • Node.js disponible para regeneradores frontend
  • ejecutar desde la raíz del monorepo

3. Qué corregir si falla

  • si falla AGENTS.md: reducirlo a 150 líneas o menos
  • si falla un generador backend: regenerar el artefacto y revisar el diff
  • si falla un generador frontend: correr el script listado en el 03_REFERENCE/README.md correspondiente
  • si falla llms-full.txt: regenerarlo con apps/gastro/scripts/build-llms-full.sh
  • si aparece una string obsoleta: corregir la doc señalada antes de cerrar el cambio

4. Regla de cierre

No cerrar cambios estructurales en apps/gastro/ sin ejecutar este gate y revisar el diff de los artefactos generados.