DeepDocs

DeepDocs ist ein GitHub KI-Agent, der Ihre technische Dokumentation perfekt mit Ihrem Code-Repository synchron hält. Wenn Sie Codeänderungen commiten, durchsucht es Ihr gesamtes Repository, um Dokumentationen zu finden, die aktualisiert werden müssen, und nimmt die notwendigen Änderungen automatisch vor.

Im Gegensatz zu herkömmlichen Dokumentationsgeneratoren, die Dateien von Grund auf neu erstellen, aktualisiert DeepDocs nur die Abschnitte, die geändert werden müssen, und bewahrt dabei Ihren ursprünglichen Stil und Ihre Formatierung. Es arbeitet mit beliebten Dokumentationstools wie Docusaurus, Mintlify, MkDocs und Read the Docs zusammen.

DeepDocs bietet eine kostenlose Version für persönliche Projekte mit 10 Scan-Credits pro Monat sowie eine Pro-Version für Teams, die häufig Code ausliefern. Diese bietet 100 Scan-Credits pro Monat und unterstützt bis zu fünf Dokumentationsdateien oder -ordner gleichzeitig.

Der Einstieg mit DeepDocs ist einfach und dauert etwa zwei Minuten. Hier sind die Schritte:

• Installieren Sie die DeepDocs-Anwendung aus dem GitHub Marketplace in Ihrem Repository, das Ihren Quellcode und Ihre Dokumentation enthält. Wenn Ihre Dokumentation in einem separaten Repository liegt, installieren Sie sie dort ebenfalls.

• Erstellen Sie eine Konfigurationsdatei namens deepdocs.yml im Stammverzeichnis Ihres Hauptzweigs. Diese Datei teilt DeepDocs mit, welche Dokumentationsdateien oder -ordner Sie mit Ihrem Code synchron halten möchten.

• Committen Sie die Konfigurationsdatei in Ihr Repository. DeepDocs führt sofort einen vollständigen Scan Ihres Codebestands durch, erkennt veraltete Dokumentation und sendet Ihnen einen detaillierten E-Mail-Bericht mit vorgeschlagenen Korrekturen.

• Nach der Erstkonfiguration arbeitet DeepDocs bei jedem zukünftigen Commit automatisch, scannt Ihre Änderungen und aktualisiert die relevante Dokumentation in separaten Branches zur Überprüfung, bevor sie zusammengeführt wird.

• Automatische Dokumentationsaktualisierungen bei jedem Commit

• Vollständiges Repository-Scannen bei jeder Codeänderung

• Aktualisiert nur veraltete Abschnitte und bewahrt dabei das Format

• Detaillierte Berichte über Dokumentationsänderungen

• GitHub-native Integration mit Pull-Request-Workflow

• Funktioniert mit Monorepos und separaten Dokumentations-Repositories

• Unterstützt Docusaurus, Mintlify, MkDocs, Read the Docs

• Intelligente Aktualisierungen ohne vollständige Neuschreibungen

• E-Mail-Benachrichtigungen mit Scan-Ergebnissen

• Einfache Einrichtung in zwei Minuten