api-docs-generator

What problem does it solve?

Keeping API documentation up-to-date with code changes is a constant struggle, often leading to outdated or missing information. This Skill automates the generation and updating process, ensuring your documentation always reflects your latest codebase.

Core Features & Use Cases

• Code Change Analysis: Automatically detects code changes that impact documentation, triggering updates only when necessary.
• Multi-Format Output: Generates documentation in various formats, including OpenAPI specifications and Markdown, maintaining consistency across platforms.
• Automated Deployment: Integrates with documentation hosting solutions like GitHub Pages for seamless, hands-off deployment of updated docs.
• Use Case: Automatically generate and update your project's API documentation whenever new endpoints are added or existing ones are modified, then deploy it to your public documentation site.

Quick Start

Generate and update the API documentation for my project, ensuring it's in OpenAPI and Markdown format, and ready for deployment.