typescript-docs

Generate unified TypeScript API references, ADRs, and examples via TypeDoc.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/kizzz/eleon-client --skill typescript-docs-kizzz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/kizzz/eleon-client/tree/main/.agents/skills/typescript-docs
Command: npx skills add https://github.com/kizzz/eleon-client --skill typescript-docs-kizzz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Consolidates scattered TypeScript documentation into a single, multi-audience set of docs by generating API references, architectural decision records, and practical code examples from your codebase.

Core Features & Use Cases

  • Generate API documentation using TypeDoc and JSDoc comments to produce consistent, navigable references.
  • Create and interlink Architectural Decision Records (ADRs) to capture design rationale alongside code.
  • Provide framework-specific patterns and examples for NestJS, Express, React, Angular, and Vue.
  • Establish end-to-end documentation pipelines with versioning, cross-linking, and multi-channel publishing.

Quick Start

Run the TypeScript docs workflow to generate and publish Markdown API docs from your source code.

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 comments?

To generate TypeScript API documentation, this workflow uses a TypeDoc-based pipeline to parse JSDoc comments and produce consistent, navigable Markdown API references from your source code.

Can I use this workflow to generate docs for both NestJS and Express projects?

Yes, this documentation workflow supports generating framework-specific patterns and examples for NestJS, Express, React, Angular, and Vue projects from your TypeScript codebase.

What is the best way to consolidate scattered TypeScript documentation into one set?

The best way to consolidate scattered TypeScript documentation is to generate a unified set of API references, Architectural Decision Records, and examples tailored for developers, architects, and product teams.

How do I set up a CI pipeline to keep TypeScript docs current?

You establish an end-to-end documentation pipeline with CI integration, version control alignment, and cross-linking to ensure your TypeScript API references and ADRs stay continuously updated.

Does this workflow generate Architectural Decision Records alongside API references?

Yes, the workflow creates and interlinks Architectural Decision Records (ADRs) to capture design rationale alongside code, producing layered documentation for multiple audiences.