tsdoc

What problem does it solve?

This Skill automates the generation of TypeScript documentation using TSDoc conventions, reducing the need for manual documentation and ensuring consistency across your codebase.

Core Features & Use Cases

• Automated Documentation: Automatically generate documentation for public interfaces, functions, and classes.
• Custom Conventions: Follows custom TSDoc conventions adapted from Vendis YARD rules.
• Use Case: When developing TypeScript code for the night-orch project, this Skill can automatically generate documentation that clearly explains the intent, usage, and constraints of each code component.

Quick Start

Apply TSDoc annotations to your TypeScript code and let the tsdoc skill generate your documentation.