jsdoc-typescript-docs

What problem does it solve?

This Skill streamlines the process of documenting TypeScript codebases, ensuring clarity, maintainability, and discoverability of your code through comprehensive inline documentation and automated API generation.

Core Features & Use Cases

• Inline Documentation: Document functions, types, interfaces, classes, and enums using JSDoc comments.
• API Documentation Generation: Utilize TypeDoc to create browsable HTML API documentation from your JSDoc comments.
• Type Safety: Leverage TypeScript's type system to ensure documentation accuracy.
• Use Case: When developing a new TypeScript library, use this Skill to generate professional API documentation that developers can easily understand and use.

Quick Start

Use the jsdoc-typescript-docs skill to document the provided TypeScript code.