Docs Refresh for Openclaw

A specialized skill for syncing repository documentation with actual code state using a routed progressive-disclosure workflow.

jzg-lab
v1.0.0
Apr 3, 2026
1
736
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install docs-refresh

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install docs-refresh 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 Refresh?

Docs Refresh is a technical utility designed for Openclaw Skills to bridge the gap between codebase evolution and durable documentation. It ensures that your versioned docs remain the authoritative record system by analyzing the current repository state—including git diffs, schema changes, and architecture shifts—and updating the minimal necessary documentation files. By following a platform-neutral approach, it avoids chat-based silos and keeps knowledge close to the code where it belongs. By using Openclaw Skills like this, developers can ensure that technical knowledge is versioned alongside the code it describes.

Docs Refresh Use Cases

  • Syncing architecture docs after a major API or schema change using Openclaw Skills.
  • Bootstrapping a documentation system for a new repository to ensure a consistent knowledge base.
  • Repairing broken navigation or stale indexes in complex, multi-domain documentation trees.
  • Updating minimal authoritative docs during the development lifecycle without polluting the chat history or external wikis.

How Docs Refresh Works

  1. Analyzes the repository guidance and AGENTS.md to identify existing authority, ownership, and freshness rules.
  2. Executes a bundled collector script within the Openclaw Skills environment to evaluate the current workspace state, including staged/unstaged diffs and untracked files.
  3. Routes the workflow into one of four specific modes (Bootstrap, Minimal, Structured, or Repair) based on the repository's current documentation maturity.
  4. Inspects the source of truth, prioritizing code, tests, and schema over existing documentation to determine necessary updates.
  5. Updates only the smallest authoritative document owning the specific fact to prevent redundancy and documentation drift.
  6. Explains the result to the user, identifying which documents changed and why, without performing any automated git commits.

Docs Refresh Setup

To integrate this skill into your workflow for Openclaw Skills, ensure the skill directory is properly resolved within your repository context.

# Ensure the skill files are present in your workspace
# The skill will automatically attempt to run the bundled collector
# No external dependencies are required beyond the Openclaw Skills runtime

Docs Refresh Data Schema & Taxonomy

Docs Refresh organizes documentation updates based on a taxonomy of repository maturity. The following table describes how this Openclaw Skills utility selects target files:

Mode Repo State Primary Documentation Targets
Bootstrap No existing system README.md, AGENTS.md
Minimal Core docs exist ARCHITECTURE.md, AGENTS.md, top-level docs
Structured Split domains exist docs/**/index.md, domain-specific reference pages
Repair Broken navigation Navigation maps, indexes, and cross-link surfaces

Docs Refresh Advanced Features

  • Intelligent routing logic that adapts to the complexity of the repository documentation tree.
  • Automated state analysis using git diffs and generated artifacts as the primary source of truth.
  • Safety-first design that prohibits automatic git add or commit actions, keeping the developer in control.
  • Support for progressive disclosure, ensuring that documentation only grows as durable domains appear.
  • High compatibility with multi-agent workflows through strict adherence to AGENTS.md navigation maps within Openclaw Skills.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*