DeepDocs

DeepDocs — це агент штучного інтелекту 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

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

• Сповіщення електронною поштою з результатами сканування

• Простий процес налаштування за дві хвилини