Чек-лист ревью

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

Проверка содержимого

• Текст соответствует стайлгайду.
• Одна мысль на предложение.
• Используется активный залог.
• Нет орфографических и пунктуационных ошибок.

Проверка ссылок

• Все внутренние ссылки ведут на существующие страницы.
• Внешние ссылки актуальны и не битые.
• Якорные ссылки корректны.

Проверка оформления

• Диаграммы Mermaid отображаются корректно.
• Таблицы не превышают ширину страницы.
• Блоки кода подсвечены и читаемы.
• Заголовки иерархичны (без пропусков уровней).

Техническая проверка

• Сборка MkDocs проходит без ошибок.
• Линтер markdownlint не выдаёт критичных предупреждений.
• Изменения соответствуют структуре папки docs/.

Финальная проверка

• Навигация в mkdocs.yml обновлена.
• Страница добавлена в соответствующие разделы документации.
• Изменения описаны в pull request.

Готово? Можно публиковать! 🎉