Update Api Docs
CheckedProvides API guidance and assistance for writing, documentation, and content creation.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add agenta-ai/agenta --skill update-api-docs -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
agenta-ai
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned agenta-ai/agenta at 98ec6a278a.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 98ec6a278a
- Scanned
- 1 file, 124 lines
About this skill
What it does
This skill automatically updates API documentation based on changes to code. It analyzes existing documentation, identifies discrepancies with current code, and generates updated documentation in a standardized format. This ensures that API documentation remains accurate and reflects the latest codebase modifications.
When to use it
- After code refactoring: Automatically update documentation when APIs are modified or reorganized.
- During continuous integration/continuous deployment (CI/CD): Integrate into your CI/CD pipeline to keep documentation in sync with deployments.
- For large projects with frequent API changes: Reduce the manual effort required to maintain accurate and up-to-date API documentation.
- To standardize documentation format: Enforce a consistent style across all API documentation.
Key capabilities
- Automated documentation updates
- Discrepancy detection between code and documentation
- Standardized documentation output
- Integration with CI/CD pipelines
Example prompts
- "Update the API documentation for the
/usersendpoint." - "Generate updated documentation based on the latest changes to
src/api.js." - "Refresh all API documentation and ensure it follows the OpenAPI 3.0 specification."
Tips & gotchas
- The skill requires access to both the codebase and existing API documentation. Ensure proper permissions are configured.
- The quality of the updated documentation depends on the clarity and structure of the original code comments and documentation.