typescript-docs

Generate TypeScript documentation from JSDoc and TypeDoc annotations.

Updated Sep 10, 2025
One-click install
npx skills add https://github.com/tillysoso/mv1 --skill typescript-docs-tillysoso
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/tillysoso/mv1/tree/main/.claude/skills/typescript-docs
Command: npx skills add https://github.com/tillysoso/mv1 --skill typescript-docs-tillysoso

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generating and maintaining comprehensive TypeScript documentation across API references, ADRs, and examples is tedious and error-prone; this skill automates and standardizes the process for multiple audiences and frameworks.

Core Features & Use Cases

  • TypeDoc-based API reference generation for TypeScript projects
  • JSDoc pattern enforcement and ESLint validation
  • ADR creation and maintenance for architectural decisions
  • Framework-specific patterns for NestJS, Express, React, Angular, and Vue
  • CI/CD templates for docs-generation, validation, and publishing
  • Use Case: Produce ADRs and API docs for a NestJS backend with example snippets

Quick Start

Generate the docs by running the TypeScript documentation pipeline in your project.

Frequently Asked Questions about typescript-docs

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

FAQPage Schema
How do I generate TypeScript API documentation from JSDoc annotations?▼

You generate TypeScript API documentation by running a TypeDoc pipeline that parses JSDoc annotations, enforces patterns with ESLint validation, and outputs structured API references.

What's the best way to maintain ADRs alongside API docs in a NestJS project?▼

Maintaining ADRs and API docs for NestJS involves an automated pipeline applying framework-specific patterns to generate and validate both architectural decisions and references.

Does this TypeScript documentation generator work with React and Vue?▼

Yes, the TypeScript documentation generator supports React and Vue, providing framework-specific patterns and example snippets alongside Express, Angular, and NestJS.

Can I validate TypeScript docs in a CI/CD workflow?▼

Yes, you can validate TypeScript docs in a CI/CD workflow using provided templates that automate JSDoc pattern enforcement, ESLint validation, and TypeDoc generation.

Do I need ESLint configured to automate TypeScript documentation generation?▼

Yes, ESLint configuration is required to enforce JSDoc patterns and validate generated TypeScript documentation, ensuring the output remains accurate and standardized.

Why are my TypeDoc generated API references missing framework-specific examples?▼

TypeDoc generated API references lack framework-specific examples when the pipeline lacks appropriate patterns for NestJS, Express, React, Angular, or Vue configurations.