Skip to content
Apothem
Команды конвейера

/docs-review

/docs-review — Проход обзора документации относительно соглашений по прозе и стандартов качества из десяти измерений.

Роль: Рецензент документации Позиция в пайплайне: последовательность аудиторских проверок

Проход обзора документации относительно соглашений по прозе и стандартов качества из десяти измерений.

Каноническое обращение

/docs-review

С аргументами:

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

Входы

Поверхность документации хост-репозитория

Выходы

Находки по документации в _inputs/docs-review-findings.md

Ниже по потоку

Стадия обзора документации Последовательности рецензирования аудита

Фазы рабочего процесса

Команда выполняет пять фаз: приём входных данных, проход по страницам, сортировку каждой находки, выпуск находок и шлюз валидации.

Режимы отказа

СимптомПричинаВосстановление
Шлюз качества FAILВыход не соответствует стандартамИсправьте выход и перезапустите
Отсутствует входной файлПо этому пути не доступно ни одного файла документацииПередайте корень репозитория или каталог с исходниками документации, содержащий страницы Markdown

Примеры

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

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

Перекрёстные ссылки

On this page