Skip to content
Apothem
Perintah pipeline

/docs-review

/docs-review — Pass tinjauan dokumentasi terhadap konvensi prosa dan standar kualitas sepuluh dimensi.

Peran: Peninjau dokumentasi Posisi pipeline: benteng

Pass tinjauan dokumentasi terhadap konvensi prosa dan standar kualitas sepuluh dimensi.

Pemanggilan kanonik

/docs-review

Dengan argumen:

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

Masukan

Permukaan dokumentasi repositori host

Keluaran

Temuan dokumentasi di _inputs/docs-review-findings.md

Hilir

Tahap tinjauan dokumentasi dari Urutan Tinjauan Audit

Fase alur kerja

Perintah ini menjalankan lima fase: penyerapan masukan, penelusuran per-halaman, triase per-temuan, emisi temuan, dan gerbang validasi.

Mode kegagalan

GejalaPenyebabPemulihan
Gerbang kualitas FAILKeluaran tidak memenuhi standarPerbaiki keluaran dan jalankan ulang
File masukan hilangTidak ada berkas dokumentasi yang dapat dijangkau pada jalur tersebutBerikan root repositori atau direktori sumber dokumentasi yang berisi halaman Markdown

Contoh

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

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

Referensi silang

On this page