shipflow-docs

What problem does it solve?

This Skill automates the generation and updating of project documentation, ensuring that your code, APIs, and components are well-described and discoverable.

Core Features & Use Cases

• File Documentation: Generates inline documentation for specific code files.
• README Generation/Update: Creates or updates the project's main README file.
• API Documentation: Documents all API routes and endpoints.
• Component Documentation: Documents UI components and their props.
• Gap Detection: Identifies and suggests areas needing documentation.
• Use Case: After adding new API endpoints to your project, run this Skill with the 'api' argument to automatically generate documentation for them in docs/API.md.

Quick Start

Use the shipflow-docs skill to generate documentation for the README file.