DeepDocs

DeepDocs to agent AI na GitHub, który utrzymuje Twoją dokumentację techniczną w idealnej synchronizacji z bazą kodu. Gdy zatwierdzasz zmiany w kodzie, skanuje całe repozytorium, aby znaleźć dokumentację wymagającą aktualizacji i automatycznie wprowadza niezbędne zmiany.

W przeciwieństwie do tradycyjnych generatorów dokumentacji, które tworzą pliki od podstaw, DeepDocs aktualizuje tylko te sekcje, które wymagają zmiany, zachowując oryginalny styl i formatowanie. Działa z popularnymi narzędziami do dokumentacji, takimi jak Docusaurus, Mintlify, MkDocs i Read the Docs.

DeepDocs oferuje darmową wersję do projektów osobistych z 10 kredytami na skanowanie miesięcznie oraz wersję Pro dla zespołów, które często wdrażają kod, zapewniając 100 kredytów na skanowanie miesięcznie oraz wsparcie dla maksymalnie pięciu plików lub folderów dokumentacji jednocześnie.

Rozpoczęcie pracy z DeepDocs jest proste i zajmuje około dwóch minut. Oto kroki:

• Zainstaluj aplikację DeepDocs z GitHub Marketplace w swoim repozytorium, które zawiera kod źródłowy i dokumentację. Jeśli Twoja dokumentacja znajduje się w osobnym repozytorium, zainstaluj ją również tam.

• Utwórz plik konfiguracyjny o nazwie deepdocs.yml w katalogu głównym swojej głównej gałęzi. Plik ten informuje DeepDocs, które pliki lub foldery dokumentacji chcesz synchronizować z kodem.

• Zatwierdź plik konfiguracyjny w swoim repozytorium. DeepDocs natychmiast przeprowadzi pełne skanowanie bazy kodu, wykryje przestarzałą dokumentację i wyśle Ci szczegółowy raport e-mail z proponowanymi poprawkami.

• Po wstępnej konfiguracji DeepDocs działa automatycznie przy każdym kolejnym zatwierdzeniu, skanując zmiany i aktualizując odpowiednią dokumentację w osobnych gałęziach do Twojej weryfikacji przed scaleniem.

• Automatyczne aktualizacje dokumentacji przy każdym commicie

• Pełne skanowanie repozytorium przy każdej zmianie w kodzie

• Aktualizuje tylko przestarzałe sekcje, zachowując formatowanie

• Szczegółowe raporty zmian w dokumentacji

• Natywna integracja z GitHub w ramach workflow pull requestów

• Współpracuje z monorepozytoriami i oddzielnymi repozytoriami dokumentacji

• Obsługuje Docusaurus, Mintlify, MkDocs, Read the Docs

• Inteligentne aktualizacje bez pełnych przepisów

• Powiadomienia e-mail z wynikami skanowania

• Łatwy proces konfiguracji trwający dwie minuty