Die Installation und Konfiguration von DeepDocs ist sehr einfach und erfordert nur die folgenden Schritte:
- Installieren der GitHub-AnwendungIn einem GitHub-Repository gehen Sie zu Einstellungen > GitHub Apps, suchen im Marketplace nach DeepDocsAI, klicken auf Konfigurieren und wählen das Code-Repository aus, das Sie überwachen möchten.
- Erstellen von KonfigurationsdateienErstellen Sie eine Konfigurationsdatei namens deepdocs.yml im Stammverzeichnis des Repositorys. Eine Beispielkonfiguration ist unten abgebildet:
target: - url: "docs/" reinit: "random-string" ignore: []
Mit target wird der Pfad des überwachten Dokuments angegeben, mit reinit wird die Überprüfung manuell ausgelöst, und mit ignore werden die zu ignorierenden Dateien angegeben.
- Konfigurationsdatei einreichenCommit deepdocs.yml in den zu überwachenden Zweig (z.B. main oder dev) und DeepDocs wird automatisch einen ersten Deep Scan auslösen.
Einmal konfiguriert, beginnt DeepDocs mit der Überwachung von Codeänderungen und aktualisiert automatisch die entsprechende Dokumentation, wobei alle Aktualisierungen als neue Zweige zur einfachen Überprüfung durch das Team übergeben werden.
Diese Antwort stammt aus dem ArtikelDeepDocs: das GitHub-KI-Tool zur automatischen Aktualisierung der Code-DokumentationDie
Darf nicht ohne Genehmigung vervielfältigt werden:KI-Produktivitätswerkzeuge " Wie installiert und konfiguriert man DeepDocs auf GitHub?
