← All use cases

Keep documentation up-to-date

Draw on code and other sources to keep documentation up to date automatically.

Have ZeroTwo set source code changes against the public docs, the release notes, and PR context, then write targeted documentation updates, with steps for checking them, before anything goes live.

Easy
30m

Related links

Best for

  • Developer docs, READMEs, runbooks, and migration notes tracking fast-changing behavior.

Skills & Plugins

  • GitHub
    Reads issues, pull requests, and review threads, and its gh-fix-ci skill inspects failed checks.

Starter prompt

Our latest branch changes how API keys are scoped. Compare the diff and its PR description with the docs in /docs and the README, and find every page that is now wrong. Edit only those passages, keep the existing structure and terminology, and don't mention anything from the private issue thread. Run the docs checks and give me a list of claims you couldn't verify from the code.

Introduction

Update docs with the code: ZeroTwo reads diffs, tests, and PRs, then drafts a scoped edit.

How to use

  1. Share the branch, PR, or files, and say what must stay private.
  2. Have ZeroTwo search the docs for the feature names, config keys, and commands the change touches.
  3. Edit only what needs to change, keeping structure, terminology, and frontmatter.
  4. Run the docs checks and cite evidence for each claim.

What to give ZeroTwo

SourceValue
Code and testsActual behavior
Public release notesPublic terminology and status
PR or issueWhy it changed
Docs checksDefinition of done

Make the workflow repeatable

Record rules in AGENTS.md, package a skill, or schedule a task. Scheduled runs never stop for approval, so keep a scheduled docs task to drafting edits you review afterward.

- Check docs when user-facing behavior changes.
- Only public information in public docs.

Related use cases