DeepDocs

DeepDocs is een GitHub AI-agent die je technische documentatie perfect synchroon houdt met je codebase. Wanneer je codewijzigingen commit, scant het je gehele repository om documentatie te vinden die bijgewerkt moet worden en voert automatisch de benodigde aanpassingen door.

In tegenstelling tot traditionele documentatiegeneratoren die bestanden vanaf nul creëren, werkt DeepDocs alleen de secties bij die gewijzigd moeten worden, terwijl het je oorspronkelijke stijl en opmaak intact houdt. Het werkt met populaire documentatietools zoals Docusaurus, Mintlify, MkDocs en Read the Docs.

DeepDocs biedt een gratis versie voor persoonlijke projecten met 10 scancredits per maand, en een Pro-versie voor teams die regelmatig code uitrollen, met 100 scancredits per maand en ondersteuning voor maximaal vijf documentatiebestanden of -mappen tegelijk.

Beginnen met DeepDocs is eenvoudig en duurt ongeveer twee minuten. Hier zijn de stappen:

• Installeer de DeepDocs-applicatie vanuit de GitHub Marketplace op je repository die je broncode en documentatie bevat. Als je documentatie in een aparte repository staat, installeer het daar ook.

• Maak een configuratiebestand genaamd deepdocs.yml aan in de root van je hoofdbranch. Dit bestand vertelt DeepDocs welke documentatiebestanden of -mappen je gesynchroniseerd wilt houden met je code.

• Commit het configuratiebestand naar je repository. DeepDocs zal onmiddellijk een volledige scan van je codebasis uitvoeren, verouderde documentatie detecteren en je een gedetailleerd e-mailrapport sturen met voorgestelde oplossingen.

• Na de initiële setup werkt DeepDocs automatisch bij elke toekomstige commit, scant het je wijzigingen en werkt het relevante documentatie bij in aparte branches voor jouw beoordeling voordat het wordt samengevoegd.

• Automatische documentatie-updates bij elke commit

• Volledige repository-scan bij elke codewijziging

• Update alleen verouderde secties terwijl de opmaak behouden blijft

• Gedetailleerde rapporten van documentatiewijzigingen

• GitHub-native integratie met pull request workflow

• Werkt met monorepos en aparte documentatierepositories

• Ondersteunt Docusaurus, Mintlify, MkDocs, Read the Docs

• Intelligente updates zonder volledige herschrijvingen

• E-mailmeldingen met scanresultaten

• Eenvoudig installatieproces van twee minuten