docs-sync Skill
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/z Published by openai in openai-agents-python.
What is docs-sync Skill?
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/z Published by openai in openai-agents-python. This profile combines repository metadata with install, compatibility, and usage signals so developers can quickly decide whether it fits their agent workflow before opening the source repository.
Automated repository signals based on public metadata such as recency, license, installation evidence, and adoption. These are not a security audit or endorsement.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Security review
- Documentation
- Security review use cases
- Documentation use cases
Technical details
- Install or run with Copy skill directory
When to use docs-sync Skill
- Use it for security review.
- Use it for documentation.
Built with
Editorial notes
Source
- Creator: openai
- Repository: openai/openai-agents-python
- Skill file: .agents/skills/docs-sync/SKILL.md
What it does
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/z
Skill instructions
Docs Sync Overview Identify doc coverage gaps and inaccuracies by comparing main branch features and configuration options against the current docs structure, then propose targeted improvements. Workflow 1. Confirm scope and base branch - Identify the current branch and default branch (usually main). - Prefer analyzing the current branch to keep work aligned with in-flight changes. - If the current branch is not main, analyze only the diff vs main to scope doc updates. - Avoid switching branches if it would disrupt local changes; use git show main:<path or git worktree add when needed. 2. Build a feature inventory from the selected scope - If on main: inventory the full surface area and review docs comprehensively. - If not on main: inventory only changes vs main (feature additions/changes/removals). - Focus on user-facing behavior: public exports, configuration options, environment variables, CLI commands, default values, and documented runtime behaviors. - Capture evidence for each i
Explore related resources
Frequently asked questions
What is docs-sync?
docs-sync is a open-source AI agent skill with Copy skill directory. Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/.
Who is docs-sync best for?
docs-sync is best for reusing agent instructions, scripts, and references, security review workflows, documentation workflows.
How do I install docs-sync?
Install or run docs-sync using Copy skill directory. Check docs-sync for the latest setup command.
Is docs-sync actively maintained?
docs-sync may need a closer maintenance check before production use.
Auto-fetched from GitHub.
