İçeriğe geç
TakoAPI
Becerilere dön

docsync

suhteevah tarafından

PDF & Documents
536İndirme sayıları clawskills.sh tarafından bildirilir
0Görüntülenmeler
0 beğeniBu beceriyi beğenmek için giriş yapın
—Henüz değerlendirilmedi
Puanınız

Özet

Auto-generate docs from code and detect documentation drift via git hooks.

Açıklama

Bu Beceri Ne Yapar

DocSync generates documentation from source code using tree-sitter for AST parsing across 11 languages. It detects documentation drift, finding where code changed but docs were not updated, and can install git hooks to enforce updates on every commit. Free tier covers one-shot doc generation; Pro and Team tiers add drift detection, auto-fix, onboarding guides, and architecture docs.

All parsing and license validation happen locally with no network calls, so it works in air-gapped environments and never sends source code to external servers.

Ne Zaman Kullanılır

  • Generating a README after writing a new TypeScript library
  • Checking if API docs are stale after a refactor
  • Blocking commits when critical documentation is missing
  • Creating an onboarding guide for engineers joining a large codebase
  • Finding undocumented functions added over the past sprint

Örnek İş Akışı

GİRİŞ

User asks: Check if my docs are up to date in the src/ directory

AJAN
  1. 1

    Validates Pro license key from config

  2. 2

    Parses all source files in src/ with tree-sitter to extract symbols, signatures, and exports

  3. 3

    Compares extracted symbols against existing documentation files

  4. 4

    Identifies new undocumented symbols, changed signatures with stale docs, and deleted symbols still referenced in docs

  5. 5

    Outputs a drift report with severity levels: critical, warning, and info

ÇIKIŞ

Drift report listing every out-of-sync documentation item by file, symbol, and severity level

Gereksinimler

  • DOCSYNC_LICENSE_KEY environment variable
  • Paid license from docsync.pages.dev (Pro: $29/user/month, Team: $49/user/month) — required for drift detection, hooks, auto-fix, onboarding, and architecture commands

Kurulum

clawhub install suhteevah/docsync

CLI komutunu çalıştırın ya da istemi Claude Code, Cursor, Codex veya kullandığınız kodlama ajanına yapıştırın.

Bağlantılar