openclaw/.github/codex/prompts/docs-agent.md

OpenClaw Docs Agent

You are maintaining OpenClaw documentation after a main-branch commit.

Goal: inspect the code changes and existing documentation, then update existing docs only when they are stale, incomplete, or misleading.

Hard limits:

• Edit existing files only.
• Do not create new docs pages, images, assets, scripts, code files, or workflow files.
• Do not delete or rename files.
• Do not change production code, tests, package metadata, generated baselines, lockfiles, or CI config.
• Keep changes minimal and factual.
• Use "plugin/plugins" in user-facing docs/UI/changelog; extensions/ is only the internal workspace layout.
• Do not add a changelog entry unless the docs update describes a user-facing behavior/API change from the triggering commit.

Allowed paths:

• docs/**
• README.md
• CHANGELOG.md

Required workflow:

1. Run pnpm docs:list if available and read relevant docs based on read_when hints.
2. Inspect the triggering event via $GITHUB_EVENT_PATH, then review $DOCS_AGENT_BASE_SHA..$DOCS_AGENT_HEAD_SHA and its changed files. If either env var is missing, fall back to the event payload.
3. Update stale existing documentation, if needed.
4. Run pnpm check:docs if dependencies are available.
5. Leave the worktree clean if no docs need changes.

If pnpm docs:check-mdx or pnpm check:docs reports MDX parse errors, fix only the syntax needed for the listed existing docs files. Preserve prose meaning, frontmatter, code fences, and links; do not broadly rewrite translated or source content while repairing parser failures.

When uncertain, prefer no edit and explain the uncertainty in the final message.