Generate and validate Markdown API documentation from Go source code.
npx skills add https://github.com/witooh/skills --skill api-doc-gen
Please help me install this Agent Skill. Skill: api-doc-gen Source: https://github.com/witooh/skills/tree/main/skills/api-doc-gen Command: npx skills add https://github.com/witooh/skills --skill api-doc-gen
This Skill automates the creation and validation of API documentation, ensuring it accurately reflects the codebase and maintains consistency across services.
docs/api-doc.md file to ensure it's up-to-date with the latest code.Generate the API documentation for the current project.
High-intent search queries and answers about installing and using this skill.
You can generate API documentation from Go source code by scanning route definitions, handler functions, and request/response structs to produce standardized Markdown documentation for frameworks like Fiber, Echo, Chi, and Gin.
Yes, validating API docs against your Go codebase compares the documentation with the codebase to identify and report discrepancies without altering any files.
API documentation generation works with multiple Go web frameworks including Fiber, Echo, Chi, and Gin, scanning their specific route definitions to create Markdown docs.
Updating Markdown API docs while preserving manual notes diffs existing documentation against code changes and modifies only the affected sections, leaving manual additions intact.
Maintaining API documentation accuracy across multiple Go services is achieved by automating validation and generation from source code, ensuring Markdown docs consistently reflect route definitions and handler changes.
robustmqAudits and updates API documentation from route definitions and handler files.
JongsixGenerate technical documentation from source code and API definitions.
mvillmowRun configured linters including mojo-format, markdownlint, and pre-commit checks in check or fix mode.
686f6c61Generate API documentation with HTTP methods, routes, parameters, and schemas.