{ "schemaVersion": "1.0", "item": { "slug": "docsync", "name": "DocSync", "source": "tencent", "type": "skill", "category": "效率提升", "sourceUrl": "https://clawhub.ai/suhteevah/docsync", "canonicalUrl": "https://clawhub.ai/suhteevah/docsync", "targetPlatform": "OpenClaw" }, "install": { "downloadMode": "redirect", "downloadUrl": "/downloads/docsync", "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync", "sourcePlatform": "tencent", "targetPlatform": "OpenClaw", "installMethod": "Manual import", "extraction": "Extract archive", "prerequisites": [ "OpenClaw" ], "packageFormat": "ZIP package", "includedAssets": [ "config/lefthook.yml", "README.md", "scripts/analyze.sh", "scripts/docsync.sh", "scripts/drift.sh", "scripts/generate.sh" ], "primaryDoc": "SKILL.md", "quickSetup": [ "Download the package from Yavira.", "Extract the archive and review SKILL.md first.", "Import or place the package into your OpenClaw setup." ], "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run." } ] }, "sourceHealth": { "source": "tencent", "slug": "docsync", "status": "healthy", "reason": "direct_download_ok", "recommendedAction": "download", "checkedAt": "2026-04-29T17:08:11.231Z", "expiresAt": "2026-05-06T17:08:11.231Z", "httpStatus": 200, "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync", "contentType": "application/zip", "probeMethod": "head", "details": { "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync", "contentDisposition": "attachment; filename=\"docsync-1.0.1.zip\"", "redirectLocation": null, "bodySnippet": null, "slug": "docsync" }, "scope": "item", "summary": "Item download looks usable.", "detail": "Yavira can redirect you to the upstream package for this item.", "primaryActionLabel": "Download for OpenClaw", "primaryActionHref": "/downloads/docsync" }, "validation": { "installChecklist": [ "Use the Yavira download entry.", "Review SKILL.md after the package is downloaded.", "Confirm the extracted package contains the expected setup assets." ], "postInstallChecks": [ "Confirm the extracted package includes the expected docs or setup files.", "Validate the skill or prompts are available in your target agent workspace.", "Capture any manual follow-up steps the agent could not complete." ] }, "downloadPageUrl": "https://openagent3.xyz/downloads/docsync", "agentPageUrl": "https://openagent3.xyz/skills/docsync/agent", "manifestUrl": "https://openagent3.xyz/skills/docsync/agent.json", "briefUrl": "https://openagent3.xyz/skills/docsync/agent.md" }, "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run." } ] }, "documentation": { "source": "clawhub", "primaryDoc": "SKILL.md", "sections": [ { "title": "DocSync — Living Documentation for Your Codebase", "body": "DocSync generates documentation from your code and keeps it in sync automatically. It uses tree-sitter for multi-language AST parsing, lefthook for git hook integration, and difftastic for semantic change detection." }, { "title": "Free Tier (No license required)", "body": "docsync generate \n\nGenerate a one-shot README or API doc for a single file or directory.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" generate \n\nWhat it does:\n\nParses the target file(s) with tree-sitter to extract symbols (functions, classes, exports, types, interfaces)\nApplies the appropriate template from /templates/\nGenerates a markdown documentation file alongside the source\n\nExample usage scenarios:\n\n\"Generate docs for src/utils/auth.ts\" → runs docsync generate src/utils/auth.ts\n\"Document this whole directory\" → runs docsync generate src/api/\n\"Create a README for this project\" → runs docsync generate ." }, { "title": "Pro Tier ($29/user/month — requires DOCSYNC_LICENSE_KEY)", "body": "docsync drift [directory]\n\nScan for documentation drift — find where code has changed but docs haven't been updated.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" drift [directory]\n\nWhat it does:\n\nValidates license key from config\nParses all source files with tree-sitter\nCompares extracted symbols against existing documentation\nReports: new undocumented symbols, changed signatures with stale docs, deleted symbols still in docs\nOutputs a drift report with severity levels (critical/warning/info)\n\ndocsync hooks install\n\nInstall git hooks that automatically check for doc drift on every commit.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" hooks install\n\nWhat it does:\n\nValidates Pro+ license\nCopies lefthook config to project root\nInstalls lefthook pre-commit hook\nOn every commit: analyzes staged files, blocks commit if critical drift detected, offers auto-regen\n\ndocsync hooks uninstall\n\nRemove DocSync git hooks.\n\nbash \"/scripts/docsync.sh\" hooks uninstall\n\ndocsync auto-fix [directory]\n\nAuto-regenerate stale documentation for files with detected drift.\n\nbash \"/scripts/docsync.sh\" auto-fix [directory]" }, { "title": "Team Tier ($49/user/month — requires DOCSYNC_LICENSE_KEY with team tier)", "body": "docsync onboarding [directory]\n\nGenerate a comprehensive onboarding guide for new developers.\n\nbash \"/scripts/docsync.sh\" onboarding [directory]\n\ndocsync architecture [directory]\n\nGenerate architecture documentation showing module relationships and data flow.\n\nbash \"/scripts/docsync.sh\" architecture [directory]" }, { "title": "Supported Languages", "body": "DocSync uses tree-sitter grammars and supports:\n\nJavaScript / TypeScript (including JSX/TSX)\nPython\nRust\nGo\nJava\nC / C++\nRuby\nPHP\nC#\nSwift\nKotlin" }, { "title": "Configuration", "body": "Users can configure DocSync in ~/.openclaw/openclaw.json:\n\n{\n \"skills\": {\n \"entries\": {\n \"docsync\": {\n \"enabled\": true,\n \"apiKey\": \"YOUR_LICENSE_KEY_HERE\",\n \"config\": {\n \"outputDir\": \"docs\",\n \"templateOverrides\": {},\n \"excludePatterns\": [\"**/node_modules/**\", \"**/dist/**\", \"**/.git/**\"],\n \"languages\": [\"typescript\", \"python\", \"go\"],\n \"driftThreshold\": \"warning\",\n \"autoFix\": false\n }\n }\n }\n }\n}" }, { "title": "Important Notes", "body": "Free tier works immediately with no configuration\nPro/Team tiers require a license key from https://docsync.pages.dev\nAll processing happens locally — no code is sent to external servers\nLicense validation is offline — no network calls needed\nGit hooks use lefthook which must be installed (see install metadata above)\ntree-sitter and difftastic are optional but recommended for best results; the skill falls back to regex-based parsing if unavailable" }, { "title": "Error Handling", "body": "If tree-sitter is not installed, fall back to regex-based symbol extraction (less accurate but functional)\nIf lefthook is not installed and user tries hooks install, prompt to install it\nIf license key is invalid or expired, show clear message with link to https://docsync.pages.dev/renew\nIf a language grammar is not available, skip that file with a warning" }, { "title": "When to Use DocSync", "body": "The user might say things like:\n\n\"Generate docs for this file/project\"\n\"Are my docs up to date?\"\n\"Check for documentation drift\"\n\"Set up auto-docs on my commits\"\n\"Create an onboarding guide\"\n\"Document the architecture\"\n\"What's undocumented in this codebase?\"" } ], "body": "DocSync — Living Documentation for Your Codebase\n\nDocSync generates documentation from your code and keeps it in sync automatically. It uses tree-sitter for multi-language AST parsing, lefthook for git hook integration, and difftastic for semantic change detection.\n\nCommands\nFree Tier (No license required)\ndocsync generate \n\nGenerate a one-shot README or API doc for a single file or directory.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" generate \n\n\nWhat it does:\n\nParses the target file(s) with tree-sitter to extract symbols (functions, classes, exports, types, interfaces)\nApplies the appropriate template from /templates/\nGenerates a markdown documentation file alongside the source\n\nExample usage scenarios:\n\n\"Generate docs for src/utils/auth.ts\" → runs docsync generate src/utils/auth.ts\n\"Document this whole directory\" → runs docsync generate src/api/\n\"Create a README for this project\" → runs docsync generate .\nPro Tier ($29/user/month — requires DOCSYNC_LICENSE_KEY)\ndocsync drift [directory]\n\nScan for documentation drift — find where code has changed but docs haven't been updated.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" drift [directory]\n\n\nWhat it does:\n\nValidates license key from config\nParses all source files with tree-sitter\nCompares extracted symbols against existing documentation\nReports: new undocumented symbols, changed signatures with stale docs, deleted symbols still in docs\nOutputs a drift report with severity levels (critical/warning/info)\ndocsync hooks install\n\nInstall git hooks that automatically check for doc drift on every commit.\n\nHow to execute:\n\nbash \"/scripts/docsync.sh\" hooks install\n\n\nWhat it does:\n\nValidates Pro+ license\nCopies lefthook config to project root\nInstalls lefthook pre-commit hook\nOn every commit: analyzes staged files, blocks commit if critical drift detected, offers auto-regen\ndocsync hooks uninstall\n\nRemove DocSync git hooks.\n\nbash \"/scripts/docsync.sh\" hooks uninstall\n\ndocsync auto-fix [directory]\n\nAuto-regenerate stale documentation for files with detected drift.\n\nbash \"/scripts/docsync.sh\" auto-fix [directory]\n\nTeam Tier ($49/user/month — requires DOCSYNC_LICENSE_KEY with team tier)\ndocsync onboarding [directory]\n\nGenerate a comprehensive onboarding guide for new developers.\n\nbash \"/scripts/docsync.sh\" onboarding [directory]\n\ndocsync architecture [directory]\n\nGenerate architecture documentation showing module relationships and data flow.\n\nbash \"/scripts/docsync.sh\" architecture [directory]\n\nSupported Languages\n\nDocSync uses tree-sitter grammars and supports:\n\nJavaScript / TypeScript (including JSX/TSX)\nPython\nRust\nGo\nJava\nC / C++\nRuby\nPHP\nC#\nSwift\nKotlin\nConfiguration\n\nUsers can configure DocSync in ~/.openclaw/openclaw.json:\n\n{\n \"skills\": {\n \"entries\": {\n \"docsync\": {\n \"enabled\": true,\n \"apiKey\": \"YOUR_LICENSE_KEY_HERE\",\n \"config\": {\n \"outputDir\": \"docs\",\n \"templateOverrides\": {},\n \"excludePatterns\": [\"**/node_modules/**\", \"**/dist/**\", \"**/.git/**\"],\n \"languages\": [\"typescript\", \"python\", \"go\"],\n \"driftThreshold\": \"warning\",\n \"autoFix\": false\n }\n }\n }\n }\n}\n\nImportant Notes\nFree tier works immediately with no configuration\nPro/Team tiers require a license key from https://docsync.pages.dev\nAll processing happens locally — no code is sent to external servers\nLicense validation is offline — no network calls needed\nGit hooks use lefthook which must be installed (see install metadata above)\ntree-sitter and difftastic are optional but recommended for best results; the skill falls back to regex-based parsing if unavailable\nError Handling\nIf tree-sitter is not installed, fall back to regex-based symbol extraction (less accurate but functional)\nIf lefthook is not installed and user tries hooks install, prompt to install it\nIf license key is invalid or expired, show clear message with link to https://docsync.pages.dev/renew\nIf a language grammar is not available, skip that file with a warning\nWhen to Use DocSync\n\nThe user might say things like:\n\n\"Generate docs for this file/project\"\n\"Are my docs up to date?\"\n\"Check for documentation drift\"\n\"Set up auto-docs on my commits\"\n\"Create an onboarding guide\"\n\"Document the architecture\"\n\"What's undocumented in this codebase?\"" }, "trust": { "sourceLabel": "tencent", "provenanceUrl": "https://clawhub.ai/suhteevah/docsync", "publisherUrl": "https://clawhub.ai/suhteevah/docsync", "owner": "suhteevah", "version": "1.0.1", "license": null, "verificationStatus": "Indexed source record" }, "links": { "detailUrl": "https://openagent3.xyz/skills/docsync", "downloadUrl": "https://openagent3.xyz/downloads/docsync", "agentUrl": "https://openagent3.xyz/skills/docsync/agent", "manifestUrl": "https://openagent3.xyz/skills/docsync/agent.json", "briefUrl": "https://openagent3.xyz/skills/docsync/agent.md" } }