Docs Sync identifies code changes and automatically updates documentation files, changelogs, and site navigation to ensure your technical docs never go stale.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install docs-sync
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install docs-sync using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Docs Sync?
Docs Sync is a specialized automation utility designed to bridge the gap between source code and technical documentation. By analyzing git diffs and Pull Request metadata, this Openclaw Skills tool determines exactly which parts of your documentation need attention after a code change. It handles everything from updating feature lists and architectural diagrams to managing complex navigation structures in static site generators.
Whether you are using MkDocs, Docusaurus, or VitePress, Docs Sync ensures that your documentation remains a source of truth. It works by mapping specific code modifications to documentation roles, allowing for surgical updates that maintain the existing style and tone of your project's docs without manual intervention.
Docs Sync Use Cases
- Synchronizing documentation immediately after a Pull Request is merged to keep users updated.
- Automatically updating the project CHANGELOG.md using standardized formats like Keep a Changelog.
- Managing sidebar and navigation configurations for documentation sites when new files are added or moved.
- Auditing documentation to find stale files that haven't been updated despite significant changes to the underlying code.
How Docs Sync Works
- The skill performs repository discovery to locate the root directory and detect documentation frameworks like MkDocs or Docusaurus.
- It identifies recent changes by analyzing GitHub PR files or git diff ranges to understand the scope of the update.
- Changes are mapped to specific documentation roles such as features, architecture, or conventions based on file patterns or configuration.
- Current documentation files are read to analyze existing style, structure, and content density.
- Surgical updates are drafted to modify only the necessary sections of the documentation while preserving diagrams and formatting.
- The updates are either applied directly to a new branch, presented for review, or logged as GitHub issues.
Docs Sync Setup
Ensure you have git and the GitHub CLI installed and authenticated before use.
# Authenticate with GitHub CLI
gh auth login
# The skill will auto-discover your docs, but you can add a config file
touch .docs-sync.yml
Example .docs-sync.yml configuration:
docs:
- path: docs/architecture.md
role: architecture
site:
engine: mkdocs
auto_nav: true
Docs Sync Data Schema & Taxonomy
Docs Sync organizes documentation by assigning roles to files, which can be defined in a configuration file or auto-detected by the Openclaw Skills engine.
| Role | Target Content | Trigger Event |
|---|---|---|
features |
User-facing feature descriptions | New feature additions or UI changes |
architecture |
Data flow and app structure | Refactors or new component additions |
changelog |
Version-based history | Any significant merged change |
conventions |
Dev setup and coding rules | Build process or linting changes |
api |
Function signatures and endpoints | Public API modifications |
Docs Sync Advanced Features
- Intelligent site management for MkDocs, Docusaurus, and VitePress to handle navigation and sidebar updates automatically.
- Surgical content editing that adds to existing sections rather than overwriting files, preserving manual edits.
- Documentation auditing capability that compares git log timestamps of docs against related code to identify stale content.
- Flexible application modes including direct branch commits, review-first proposals, or GitHub issue generation.
SKILL.md
Loading
Related Openclaw Skills
Token Layer
A crosschain token infrastructure that allows AI agents to launch, trade, and manage tokens across major blockchains seamlessly.
Boiling Point
A premier launchpad and trading interface for onchain AI agent tokens across multiple blockchain networks.
Kimi Search
A high-performance web search skill for Openclaw agents powered by the Moonshot Kimi API's native $web_search tool.
Gandi Domain Registrar Skill
A comprehensive integration for managing Gandi.net domains, DNS records, and email forwarding using automated Node.js scripts.
PDF Translate
A professional PDF-to-Chinese translation engine that preserves complex typography and structural elements using a Markdown-first workflow.
Docs Scraper
A high-performance CLI tool that automates browser sessions to scrape documents from Notion, DocSend, and general websites into searchable local PDF files.
Featured*
