What problem does it solve?
This Skill helps developers produce consistent, high-quality documentation for codebases by generating code docs, API references, and component guides, reducing manual effort and onboarding time.
Core Features & Use Cases
- Code Documentation: Extract and format JSDoc/TSDoc comments into organized docs for functions, classes, and modules.
- API Documentation: Generate endpoint descriptions, request/response formats, authentication requirements, and error mappings.
- Component Documentation: Document props, usage examples, accessibility notes, and visual examples.
- README Templates: Create project-wide README sections including setup, environment variables, and deployment notes.
- Use Cases: Onboarding new developers, migrating legacy docs, or maintaining up-to-date docs across microservices.
Quick Start
Run the docs-generate command on your repository to produce a complete documentation suite (code, API, component docs, and README templates).