/docs-review
/docs-review — Passe de relecture de la documentation face aux conventions de prose et aux normes de qualité à dix dimensions.
Rôle : Relecteur de documentation Position dans le pipeline : forteresse
Passe de relecture de la documentation face aux conventions de prose et aux normes de qualité à dix dimensions.
Invocation canonique
/docs-reviewAvec des arguments :
/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]Entrées
Surface de documentation du dépôt hôte
Sorties
Constats sur la documentation dans _inputs/docs-review-findings.md
En aval
L'étape de relecture de la documentation de la Séquence de Relecture d'Audit
Phases du flux de travail
La commande exécute cinq phases : ingestion des entrées, parcours page par page, tri constat par constat, émission des constats, et le portail de validation.
Modes d'échec
| Symptôme | Cause | Récupération |
|---|---|---|
| Portail de qualité FAIL | La sortie ne respecte pas les normes | Corrigez la sortie et relancez |
| Fichier d'entrée manquant | Aucun fichier de documentation n'est accessible au chemin indiqué | Passez une racine de dépôt ou un répertoire source de documentation qui contient des pages Markdown |
Exemples
# Dry-run to preview what would happen
/docs-review --dry-run
# Execute against a repository root
/docs-review path/to/repo/Renvois
/dependency-audit
/dependency-audit — Passe d'audit par dépendance (directes + transitives) pour la licence, les CVE et la fraîcheur.
/perf-audit
/perf-audit — Audite les budgets de performance par classe (runtime des hooks, verify-ecosystem, portail de conformité, tests, travailleurs délégués, shell, lint), selon la méthode USE.