Skip to content
Apothem
Comandos de la canalización

/docs-review

/docs-review — Pasada de revisión de documentación frente a las convenciones de prosa y los estándares de calidad de diez dimensiones.

Rol: Revisor de documentación Posición en la canalización: fortaleza

Pasada de revisión de documentación frente a las convenciones de prosa y los estándares de calidad de diez dimensiones.

Invocación canónica

/docs-review

Con argumentos:

/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]

Entradas

Superficie de documentación del repositorio anfitrión

Salidas

Hallazgos de documentación en _inputs/docs-review-findings.md

Aguas abajo

La etapa de revisión de documentación de la Secuencia de Revisión de Auditoría

Fases del flujo de trabajo

El comando ejecuta cinco fases: ingesta de entradas, recorrido por página, clasificación por hallazgo, emisión de hallazgos y la puerta de validación.

Modos de fallo

SíntomaCausaRecuperación
Puerta de calidad FAILLa salida no cumple los estándaresCorrige la salida y vuelve a ejecutar
Falta un archivo de entradaNo hay archivos de documentación accesibles en la rutaIndica una raíz de repositorio o un directorio de fuente de documentación que contenga páginas Markdown

Ejemplos

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a repository root
/docs-review path/to/repo/

Referencias cruzadas

On this page