DeepDocs

DeepDocs è un agente AI di GitHub che mantiene la tua documentazione tecnica perfettamente sincronizzata con il tuo codice. Quando effettui modifiche al codice, esegue la scansione dell'intero repository per trovare la documentazione che necessita di aggiornamenti e apporta automaticamente le modifiche necessarie.

A differenza dei generatori di documentazione tradizionali che creano file da zero, DeepDocs aggiorna solo le sezioni che devono essere modificate, mantenendo intatto il tuo stile e la formattazione originale. Funziona con strumenti di documentazione popolari come Docusaurus, Mintlify, MkDocs e Read the Docs.

DeepDocs offre una versione gratuita per progetti personali con 10 crediti di scansione mensili e una versione Pro per team che rilasciano codice frequentemente, fornendo 100 crediti di scansione al mese e supporto per fino a cinque file o cartelle di documentazione contemporaneamente.

Iniziare con DeepDocs è semplice e richiede circa due minuti. Ecco i passaggi:

• Installa l'applicazione DeepDocs dal GitHub Marketplace nel tuo repository che contiene il codice sorgente e la documentazione. Se la tua documentazione si trova in un repository separato, installala anche lì.

• Crea un file di configurazione chiamato deepdocs.yml nella radice del tuo branch principale. Questo file indica a DeepDocs quali file o cartelle di documentazione vuoi mantenere sincronizzati con il tuo codice.

• Effettua il commit del file di configurazione nel tuo repository. DeepDocs eseguirà immediatamente una scansione completa del tuo codice, rileverà eventuali documentazioni obsolete e ti invierà un'email dettagliata con le correzioni proposte.

• Dopo la configurazione iniziale, DeepDocs funziona automaticamente ad ogni commit futuro, scansionando le modifiche e aggiornando la documentazione rilevante in rami separati per la tua revisione prima del merge.

• Aggiornamenti automatici della documentazione ad ogni commit

• Scansione completa del repository ad ogni modifica del codice

• Aggiorna solo le sezioni obsolete preservando la formattazione

• Report dettagliati delle modifiche alla documentazione

• Integrazione nativa con GitHub nel flusso di lavoro delle pull request

• Funziona con monorepo e repository di documentazione separati

• Supporta Docusaurus, Mintlify, MkDocs, Read the Docs

• Aggiornamenti intelligenti senza riscritture complete

• Notifiche via email con i risultati della scansione

• Processo di configurazione semplice di due minuti