typescript-docs

Solid

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, architectural decision records (ADRs), code examples, and framework-specific patterns for NestJS, Express, React, Angular, and Vue.

AI & Automation 263 stars 31 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 89/100

Stars 20%
81
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# TypeScript Documentation Generate production-ready TypeScript documentation with layered architecture for multiple audiences. Supports API docs with TypeDoc, ADRs, and framework-specific patterns. ## Overview Use JSDoc annotations for inline documentation, TypeDoc for API reference generation, and ADRs for tracking design choices. **Key capabilities:** - TypeDoc configuration and API documentation generation - JSDoc patterns for all TypeScript constructs - ADR creation and maintenance - Framework-specific patterns (NestJS, React, Express, Angular, Vue) - ESLint validation rules for documentation quality - GitHub Actions pipeline setup ## When to Use Use this skill when creating API documentation, architectural decision records, code examples, or framework-specific patterns for NestJS, Express, React, Angular, or Vue. ## Quick Reference | Tool | Purpose | Command | |------|---------|---------| | TypeDoc | API documentation generation | `npx typedoc` | | Compodoc | Angular documentation | `npx compodoc -p tsconfig.json` | | ESLint JSDoc | Documentation validation | `eslint --ext .ts src/` | ### JSDoc Tags | Tag | Use Case | |-----|----------| | `@param` | Document parameters | | `@returns` | Document return values | | `@throws` | Document error conditions | | `@example` | Provide code examples | | `@remarks` | Add implementation notes | | `@see` | Cross-reference related items | | `@deprecated` | Mark deprecated APIs | ## Instructions ### 1. Configure TypeDoc ```...

Details

Author
giuseppe-trisciuoglio
Repository
giuseppe-trisciuoglio/developer-kit
Created
7 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category