update-docs Skill
Update documentation across the repo after API changes. Finds stale references in docs, examples, docstrings, and fixes them. Published by huggingface in OpenEnv.
What is update-docs Skill?
Update documentation across the repo after API changes. Finds stale references in docs, examples, docstrings, and fixes them. Published by huggingface in OpenEnv. 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
- Documentation
- Documentation use cases
Technical details
- Install or run with Copy skill directory
When to use update-docs Skill
- Use it for documentation.
Built with
Editorial notes
Source
- Creator: huggingface
- Repository: huggingface/OpenEnv
- Skill file: .claude/skills/update-docs/SKILL.md
What it does
Update documentation across the repo after API changes. Finds stale references in docs, examples, docstrings, and fixes them.
Skill instructions
/update-docs Find and fix stale documentation after API changes. EXECUTE THESE STEPS NOW When this skill is invoked, you MUST execute these steps immediately. Step 1: Identify Changed Files Run: bash git diff --name-only main...HEAD -- '.py' If no changes are found relative to main (e.g., on main or no upstream), fall back to: bash git diff --name-only HEAD1 -- '.py' If that also fails, ask the user which files changed. Collect the list of changed Python files. Step 2: Extract API Changes For each changed .py file, compare old vs new signatures using the same ref that worked in Step 1: bash If Step 1 used main...HEAD: git diff main...HEAD -- <file If Step 1 fell back to HEAD1: git diff HEAD~1 -- <file Look for changes to: - Function/method signatures (def lines) - Class names and init signatures - Module-level constants and type aliases - Removed or renamed public symbols Build a list of (oldsignature, newsignature) pairs. If no API changes are found (only internal logic changes), re
Explore related resources
Frequently asked questions
What is update-docs?
update-docs is a open-source AI agent skill with Copy skill directory. Update documentation across the repo after API changes. Finds stale references in docs, examples, docstrings, and fixes them.
Who is update-docs best for?
update-docs is best for reusing agent instructions, scripts, and references, documentation workflows.
How do I install update-docs?
Install or run update-docs using Copy skill directory. Check update-docs for the latest setup command.
Is update-docs actively maintained?
update-docs may need a closer maintenance check before production use.
Auto-fetched from GitHub.
