DeepDocs

DeepDocs, teknik dokümantasyonunuzu kod tabanınızla mükemmel uyum içinde tutan bir GitHub AI aracıdır. Kod değişiklikleri yaptığınızda, güncellenmesi gereken dokümantasyonu bulmak için tüm depoyu tarar ve gerekli değişiklikleri otomatik olarak yapar.

Dosyaları sıfırdan oluşturan geleneksel dokümantasyon oluşturucuların aksine, DeepDocs yalnızca değişiklik yapılması gereken bölümleri günceller ve orijinal stiliniz ile biçimlendirmeyi korur. Docusaurus, Mintlify, MkDocs ve Read the Docs gibi popüler dokümantasyon araçlarıyla çalışır.

DeepDocs, kişisel projeler için aylık 10 tarama kredisiyle ücretsiz bir sürüm sunar ve sık sık kod gönderen ekipler için ayda 100 tarama kredisi ve aynı anda beş dokümantasyon dosyası veya klasörüne destek sağlayan Pro sürümünü sunar.

DeepDocs ile başlaması basittir ve yaklaşık iki dakika sürer. İşte adımlar:

• Kaynak kodunuzu ve dokümantasyonunuzu içeren depoda GitHub Marketplace'ten DeepDocs uygulamasını yükleyin. Dokümantasyonunuz ayrı bir depoda bulunuyorsa, oraya da yükleyin.

• Ana dalınızın kök dizininde deepdocs.yml adlı bir yapılandırma dosyası oluşturun. Bu dosya, DeepDocs'a hangi dokümantasyon dosyalarını veya klasörlerini kodunuzla senkronize tutmak istediğinizi bildirir.

• Yapılandırma dosyasını deponuza gönderin (commit). DeepDocs hemen kod tabanınızın tam bir taramasını yapacak, güncel olmayan dokümantasyonu tespit edecek ve önerilen düzeltmelerle birlikte ayrıntılı bir e-posta raporu gönderecektir.

• İlk kurulumdan sonra, DeepDocs her gelecekteki commit'te otomatik olarak çalışır, değişikliklerinizi tarar ve incelemeniz için birleştirmeden önce ilgili dokümantasyonu ayrı dallarda günceller.

• Her commit ile otomatik dokümantasyon güncellemeleri

• Her kod değişikliğinde tam depo taraması

• Biçimlendirmeyi koruyarak sadece güncel olmayan bölümleri günceller

• Dokümantasyon değişikliklerinin detaylı raporları

• Pull request iş akışıyla GitHub yerel entegrasyonu

• Monorepo ve ayrı doküman depolarıyla çalışır

• Docusaurus, Mintlify, MkDocs, Read the Docs destekler

• Tam yeniden yazım olmadan akıllı güncellemeler

• Tarama sonuçlarıyla e-posta bildirimleri

• Kolay iki dakikalık kurulum süreci