typescript-docs

What problem does it solve?

This Skill automates the creation of comprehensive TypeScript documentation for APIs, ADRs, code examples, and framework-specific patterns across frontend and backend stacks, dramatically reducing manual writing time and ensuring consistency.

Core Features & Use Cases

• API Documentation: Generate API references using TypeDoc and related tools for TypeScript projects.
• ADR Documentation: Maintain Architectural Decision Records to capture design rationale.
• Multi-Framework Patterns: Include patterns for NestJS, Express, React, Angular, and Vue to serve multiple audiences.
• Use Case: When onboarding a new TS module, automatically generate API docs, ADRs, and example snippets.

Quick Start

Install TypeDoc and related tooling, then run the documentation generator configured for your project. For example, install typedoc and generate docs with a markdown theme, then review the resulting docs in the docs/ directory.