tsdoc

Generate TypeScript documentation from TSDoc annotations for the night-orch project.

Updated Mar 22, 2026

Search Tags:#typescript #developer tools #documentation #code generation #tsdoc

Ready to run

npx skills add https://github.com/shllg/night-orch --skill tsdoc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: tsdoc
Source: https://github.com/shllg/night-orch/tree/main/.claude/skills/tsdoc
Command: npx skills add https://github.com/shllg/night-orch --skill tsdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about tsdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate TypeScript documentation from code automatically?▼

To generate TypeScript documentation automatically, apply TSDoc annotations to your code comments and run this Skill to parse them into structured docs. It automates the extraction process for public interfaces, functions, and classes.

What are TSDoc annotations and when do I need them for documentation?▼

TSDoc annotations are standard comment formats used within TypeScript code to document component intent, usage, and constraints. You need them when you want to automate documentation generation and ensure consistent API references.

Can I use custom TSDoc conventions for a specific TypeScript project?▼

Yes, you can enforce custom TSDoc conventions adapted from rules like Vendis YARD. This Skill applies those specific annotation rules to the night-orch project to maintain strict documentation consistency.

Do I need existing TSDoc comments in my code to use this documentation generator?▼

Yes, you must manually add TSDoc annotations to your code comments first. This Skill requires existing TSDoc annotations in the codebase to parse and generate the corresponding TypeScript documentation.

What is the best way to maintain API documentation consistency in TypeScript?▼

The best way to maintain API documentation consistency is to use strict TSDoc conventions and automate generation. This prevents manual errors and ensures all public interfaces and functions follow the same standard.