DeepDocs

DeepDocs — это AI-агент для GitHub, который поддерживает вашу техническую документацию в идеальной синхронизации с кодовой базой. Когда вы вносите изменения в код, он сканирует весь репозиторий, чтобы найти документацию, требующую обновления, и автоматически вносит необходимые изменения.

В отличие от традиционных генераторов документации, которые создают файлы с нуля, DeepDocs обновляет только те разделы, которые нуждаются в изменениях, сохраняя при этом ваш оригинальный стиль и форматирование. Он работает с популярными инструментами документации, такими как Docusaurus, Mintlify, MkDocs и Read the Docs.

DeepDocs предлагает бесплатную версию для личных проектов с 10 кредитами на сканирование в месяц и профессиональную версию для команд, которые часто выпускают код, предоставляя 100 кредитов на сканирование в месяц и поддержку до пяти файлов или папок документации одновременно.

Начать работу с DeepDocs просто и занимает около двух минут. Вот шаги:

• Установите приложение DeepDocs из GitHub Marketplace в ваш репозиторий, который содержит исходный код и документацию. Если ваша документация находится в отдельном репозитории, установите его там тоже.

• Создайте файл конфигурации с именем deepdocs.yml в корне вашей основной ветки. Этот файл указывает DeepDocs, какие файлы или папки с документацией вы хотите синхронизировать с вашим кодом.

• Закоммитьте файл конфигурации в ваш репозиторий. DeepDocs сразу же выполнит полный скан вашего кода, обнаружит устаревшую документацию и отправит вам подробный отчет по электронной почте с предложенными исправлениями.

• После первоначальной настройки DeepDocs автоматически работает при каждом последующем коммите, сканируя ваши изменения и обновляя соответствующую документацию в отдельных ветках для вашего просмотра перед слиянием.

• Автоматическое обновление документации при каждом коммите

• Полное сканирование репозитория при каждом изменении кода

• Обновление только устаревших разделов с сохранением форматирования

• Подробные отчёты об изменениях в документации

• Интеграция с GitHub и рабочим процессом pull request

• Работает с монорепозиториями и отдельными репозиториями документации

• Поддержка Docusaurus, Mintlify, MkDocs, Read the Docs

• Интеллектуальные обновления без полного переписывания

• Уведомления по электронной почте с результатами сканирования

• Простой процесс настройки за две минуты