A sophisticated documentation synchronization tool that uses git analysis and multi-agent consensus to ensure code and docs stay perfectly aligned.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install contract-doc-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 contract-doc-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 Contract Doc Sync?
Contract Doc Sync is a specialized skill designed for developers who need to maintain high-fidelity documentation without manual overhead. By integrating directly into the Openclaw Skills ecosystem, it bridges the gap between source code and Markdown files located in docs folders. The skill analyzes git diffs to detect drift—instances where the implementation has evolved beyond its written description—and applies automated repairs to maintain project integrity.
This tool is built on a foundation of safety and precision, operating locally to protect code privacy. It focuses on maintaining architectural documents, API references, and module conventions. Within Openclaw Skills, it serves as an automated technical writer that understands the relationship between controllers, entities, and their corresponding documentation sections, ensuring that your technical truth remains consistent across the entire repository.
Contract Doc Sync Use Cases
- Automatically updating API reference Markdown files after modifying controller signatures or endpoints.
- Syncing technical design documents and Mermaid diagrams whenever entity structures are refactored.
- Performing a documentation consistency audit before submitting pull requests or merging branches.
- Generating a drift report to identify which parts of the documentation are outdated compared to the latest code changes.
- Maintaining cross-module documentation alignment in complex Openclaw Skills projects.
How Contract Doc Sync Works
- Phase 0 - Environment Probing: The skill detects the project documentation architecture and tech stack to build a ProjectDocProfile.
- Phase 1 - Change Discovery: It executes a Python-based analysis of local git diffs to identify which code changes impact specific documentation targets.
- Phase 2 - Sync Repair: Maps changed code components to documentation sections and applies precise edits to the Markdown files using a section parser.
- Phase 3 - Consensus Verification: Deploys multiple independent sub-agents to verify the documentation against a 10-dimension matrix, ensuring accuracy through repeated passes.
- Phase 4 - Global Scan: For high-level synchronization (L3), it performs a comprehensive scan of all contract documents to ensure zero-drift across the project.
Contract Doc Sync Setup
To deploy this skill within your Openclaw Skills environment, ensure your local system meets the following requirements:
# Verify core dependencies are installed
python3 --version
git --version
bash --version
# Optional: Install ripgrep for optimized performance
rg --version
The skill is self-configuring. When you trigger commands like sync docs or check drift, the agent automatically utilizes the $SKILL_DIR and local scripts to begin the synchronization process. No external environment variables are required for standard operation.
Contract Doc Sync Data Schema & Taxonomy
The skill organizes its operations through a structured metadata and filing system to ensure Openclaw Skills can track every change:
| Data Element | Format | Description |
|---|---|---|
| ProjectDocProfile | JSON | Defines docSystem, tracks, and code-to-doc mapping rules. |
| Drift Report | JSON | Captures changed files, categories, and specific documentation impact. |
| Section Parser | Shell Script | A specialized tool for granular reading and writing of Markdown sections. |
| Verification Matrix | Table | Tracks 10 dimensions (D1-D10) including API signatures and semantic logic. |
| Audit Log | Markdown | Detailed history of automated fixes, proposed changes, and manual review items. |
Contract Doc Sync Advanced Features
- Multi-Level Sync Protocol: Choose between L0 (Detection), L1 (Fast Sync), L2 (Consensus Sync), and L3 (Deep Semantic Audit) depending on your needs within Openclaw Skills.
- Multi-Agent Consensus: Employs a verification protocol where sub-agents must reach agreement on documentation accuracy through consecutive error-free passes.
- Semantic Consistency Engine (D10): Uses LLM-powered reasoning to verify that the natural language in your docs matches the technical logic in your code.
- Write-Protection Whitelist: Implements strict safety boundaries that only allow modifications to docs/ directories, ensuring source code remains untouched.
- Project-Specific Overrides: Allows developers to define custom documentation rules in AGENTS.md or CLAUDE.md that the skill will prioritize over default settings.
SKILL.md
Loading
Related Openclaw Skills
Text to Video Editing AI
An AI-powered video editing skill that transforms raw footage into professional clips using simple natural language text commands.
Map Optimization Strategy
A high-performance algorithmic framework for solving complex item placement and constraint optimization problems on spatial grids.
SQLite Map Parser
A technical utility for exploring SQLite database schemas and transforming relational data into structured JSON maps or arrays.
AI Video Maker Free Long
A cloud-based AI video production tool that transforms raw images and scripts into professional long-form MP4 videos with transitions and music.
Caption Generator by Image
An AI-powered video production skill that transforms static images into captioned 1080p MP4 clips using remote GPU rendering.
Image to Video No Filter
A high-performance AI skill that converts still images into unfiltered 1080p video clips using remote GPU rendering.
Featured*
