📝
Developersafety: read-only

DocsPilot

Documentation Automation Agent

An OpenClaw agent that auto-generates API docs from codebase changes, detects README staleness with update drafts, generates changelogs from git history, and scores documentation coverage across your project.

Install

tinkerclaw install docspilot

Requires the TinkerClaw CLI. Install guide →

What it does

Auto-generate API docs from codebase changes

README staleness detection and update drafts

Changelog generation from git history

Documentation coverage scoring

Skills (4)

Installed into your agent's workspace

docspilot-api

Extract and generate API documentation from source code analysis including function signatures, parameters, and return types.

docspilot-changelog

Synthesize changelogs from git history with semantic categorization following Keep a Changelog format.

docspilot-coverage

Score documentation coverage across repos, track trends, and identify the highest-impact documentation gaps.

docspilot-readme

Detect stale or incomplete READMEs, score against completeness checklist, and generate update drafts.

Automations (2)

DocsPilot — Weekly README Scan

enabled

09:00 AM · every Mon (UTC)

cron: 0 9 * * 1 · tz: Etc/UTC

What the agent does on this trigger

Run docspilot-readme and docspilot-coverage. Scan all configured repos for README staleness, score documentation coverage, and generate update drafts. Read-only policy: create draft PRs only, never commit directly.

DocsPilot — Post-Merge Changelog

enabled

every 15 minutes · every day (UTC)

cron: */15 * * * * · tz: Etc/UTC

What the agent does on this trigger

Check for new merges to base branch. If new commits found since last run, run docspilot-changelog to synthesize changelog. Read-only mode enforced.

Integrations & requirements

Primary integration mode
Local repo analysis plus Git provider APIs
MCP status
No dedicated MCP integration
Supported today
  • Local repo scanning for docs, changelogs, and API extraction
  • GitHub/GitLab API usage via `GITHUB_TOKEN` / `GITLAB_TOKEN` where needed

Files this agent creates

Written under ~/.openclaw/workspace-docspilot/

USER.mdapi-docs/generated/{repo}-api.mdapi-docs/coverage-report.md.state/last-api-scan.json.state/last-changelog-run.jsonchangelogs/latest-changelog.mdchangelogs/archive/{date}-changelog.mdcoverage/weekly-score.mdcoverage/scores.json.state/last-coverage-scan.jsonreadmes/staleness-report.mdreadmes/drafts/{repo}-readme-update.md.state/last-readme-scan.json

Install & configure

  1. 1. Install the agent pack

    tinkerclaw install docspilot

  2. 2. Configure your preferences

    Edit the per-agent USER.md to set tone, timezone, and any agent-specific preferences:

    ~/.openclaw/workspace-docspilot/USER.md

  3. 3. Keep it up to date

    tinkerclaw update docspilot

Highlights

  • ✦Auto-detects undocumented public functions and endpoints
  • ✦Generates changelogs from git history with smart grouping
  • ✦Documentation coverage scoring with gap reports