कंटेंट पर जाएँ
TakoAPI
स्किल्स पर वापस

docsync

suhteevah द्वारा

PDF & Documents
536clawskills.sh द्वारा बताए गए डाउनलोड
0व्यूज़
0 लाइकइस स्किल को लाइक करने के लिए साइन इन करें
—अभी तक कोई रेटिंग नहीं
आपकी रेटिंग

संक्षिप्त

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

विवरण

यह स्किल क्या करती है

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.

इसे कब इस्तेमाल करें

  • 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

उदाहरण वर्कफ़्लो

इनपुट

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

एजेंट
  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

आउटपुट

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

आवश्यकताएँ

  • 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

इंस्टॉलेशन

clawhub install suhteevah/docsync

CLI कमांड चलाएँ, या प्रॉम्प्ट को Claude Code, Cursor, Codex या जो भी कोडिंग एजेंट आप इस्तेमाल करते हैं उसमें पेस्ट करें।

लिंक