Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Only update English docs under docs/** and never touch translated docs under docs/ja, docs/ko, or docs/zh. Provide a report and ask for approval before editing docs.
Identify doc coverage gaps and inaccuracies by comparing main branch features and configuration options against the current docs structure, then propose targeted improvements.
Confirm scope and base branch
main).main, analyze only the diff vs main to scope doc updates.git show main:<path> or git worktree add when needed.Build a feature inventory from the selected scope
main: inventory the full surface area and review docs comprehensively.main: inventory only changes vs main (feature additions/changes/removals).rg "Settings", rg "Config", rg "os.environ", rg "OPENAI_").$openai-knowledge to pull current details from the OpenAI Developer Docs MCP server instead of guessing, while treating the SDK source code as the source of truth when discrepancies appear.Doc-first pass: review existing pages
docs/ (excluding docs/ja, docs/ko, and docs/zh).src/agents/ and examples/.Code-first pass: map features to docs
docs/ and mkdocs.yml.docs/ref.docs/ref/* pages, treat the corresponding docstrings/comments in src/ as the source of truth. Prefer updating those code comments so regenerated reference docs stay correct, instead of hand-editing the generated pages.Detect gaps and inaccuracies
Produce a Docs Sync Report and ask for approval
If approved, apply changes (English only)
docs/**.docs/ja, docs/ko, or docs/zh.mkdocs.yml when adding or renaming pages.make build-docs after edits to verify the docs site still builds.Use this template when reporting findings:
Docs Sync Report
references/doc-coverage-checklist.md