Создание автоматизированного конвейера документации на PHP с помощью Autodocs и GitHub Actions

Библиотека Autodocs предназначена для упрощения создания высококастомизируемых автоматизированных документаций на основе шаблонов Markdown. Совместно с приложением Minicli, она предоставляет уровень абстракции и структуру, на основе которых можно создавать собственную фабрику документации.

Этот проект создан, чтобы облегчить процесс поддержки документации для Chainguard Images, который теперь поддерживает более тысячи страниц документации в рамках рабочего процесса на основе GitHub с запусками каждую ночь.

Страницы определяются как классы, следующие определенному интерфейсу. Источники данных могут быть загружены автоматически как JSON-файлы кэша, что облегчает распределенные настройки, где данные поступают из различных источников. Этот распределенный подход упрощает интеграцию Autodocs с существующими рабочими процессами и конвейерами, особенно при использовании GitHub Actions.

Также включено пошаговое руководство по созданию демонстрационного приложения Autodocs для генерации персональных README-страниц на GitHub. Она включает следующие шаги:

1️⃣Создание демонстрационного приложения Minicli.
2️⃣Настройка опций Autodocs.
3️⃣Регистрация службы Autodocs.
4️⃣Создание команды сборки.
5️⃣Создание страницы документации.
6️⃣Запуск демонстрационного процесса с использованием GitHub Actions (необязательно).