An intelligent workflow agent that synchronizes project documentation with code changes through full audits or incremental git diffs.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install update-project-docs
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 update-project-docs 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 Documentation Updater?
Documentation Updater is a sophisticated AI agent skill designed to bridge the gap between rapidly evolving source code and static documentation. By leveraging Openclaw Skills, this tool automates the tedious process of identifying which parts of your documentation are missing, outdated, or obsolete based on your recent git commits.
Whether you are managing a massive monorepo or a small utility, this skill adapts to your existing documentation framework—supporting everything from Docusaurus and MkDocs to zero-build systems like Docsify. It ensures your technical debt remains low by enforcing a strict sync-point record, allowing for precise incremental updates every time you modify your codebase.
Documentation Updater Use Cases
- Automatically updating API references when function signatures change in the source code.
- Performing a full-project audit to identify documentation gaps in legacy repositories.
- Scaffolding brand new documentation infrastructure for projects that lack a formal doc site.
- Cleaning up obsolete documentation and merging redundant guides to improve maintainability.
- Ensuring sidebar navigation and file system structures remain perfectly aligned after feature refactors.
How Documentation Updater Works
- Pre-flight Check: The skill verifies a clean working tree and locates the last recorded sync point using a .docs-sync file or metadata tags.
- Run Mode Selection: It determines if a full-project audit is required (first-run) or if it can perform an incremental review based on a git diff from the last sync hash.
- Structure Discovery: It analyzes the repository to find documentation roots, configuration files (like mkdocs.yml), and navigation hierarchies.
- Gap Analysis: By comparing code symbols to documentation content, it maps out what needs to be created, updated, or deleted.
- Execution: The skill scaffolds missing files, updates existing ones, and restructures directories to match the project's sidebar requirements.
- Validation & Sync: It runs project-specific linting tools and records a new commit hash to mark the documentation as synced with the current code state.
Documentation Updater Setup
To use this within the Openclaw Skills environment, ensure your repository is a git-managed project. No specific global installation is required other than providing access to your codebase.
# Check if your project is ready for a sync record
ls -a | grep .docs-sync
# If starting fresh, the skill will guide you to create the initial record:
echo "<current-git-hash>" > .docs-sync
Documentation Updater Data Schema & Taxonomy
The skill manages its state and understands project topology through the following schema:
| File/Component | Description |
|---|---|
| .docs-sync | A tracking file containing the last synced commit hash and an ISO-8601 timestamp. |
| Sidebar Config | Sources of truth like _sidebar.md or sidebars.js used to define documentation hierarchy. |
| Navigation Map | A logical mapping between source code directories (e.g., /src) and doc directories (e.g., /docs/api). |
| Metadata | Frontmatter in Markdown files (YAML/TOML) used to track versioning and document-specific sync states. |
Documentation Updater Advanced Features
- Full-Project Audit: A deep-scan mode that reads the entire codebase to establish a baseline for future updates.
- Absolute Path Enforcement: Automatically converts relative sidebar links to absolute paths to prevent 404 errors in nested Doc sites.
- Docsify Scaffolding: Automatically generates a complete, zero-build documentation site if no infrastructure is detected.
- Incremental Diff Filtering: Intelligently skips internal-only refactors while prioritizing public-facing API changes.
- Multi-System Support: Native recognition of MkDocs, Docusaurus, Sphinx, mdBook, VitePress, and more.
SKILL.md
Loading
Related Openclaw Skills
Agency Agents
A comprehensive library of 193 plug-and-play AI expert agents designed to handle professional tasks across engineering, design, marketing, and business sectors.
Hermes Agent Integration
Connect OpenClaw with the NousResearch Hermes Agent to leverage autonomous learning cycles and multi-platform agent orchestration.
obclip
A specialized CLI utility designed to transform live web pages into clean, structured Markdown files or integrated Obsidian notes.
Batch Send Mail
A specialized tool for sending high-volume, personalized emails by merging spreadsheet data with custom templates.
Requirements Specification
A professional framework for generating complete, measurable, and actionable product requirements documents using an 8-dimension structured approach.
LLM Key Pool
A sophisticated API key management system featuring multi-tier rotation and intelligent failover to ensure uninterrupted LLM access.
Featured*
