typescript-docs

Generate TypeScript API documentation with TypeDoc and ESLint validation.

395|50|Updated Jul 5, 2017

Search Tags:#typescript #documentation #adr #jsdoc #api-docs #typedoc

Ready to run

npx skills add https://github.com/alonronin/mockingoose --skill typescript-docs-alonronin

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/alonronin/mockingoose/tree/main/.agents/skills/typescript-docs
Command: npx skills add https://github.com/alonronin/mockingoose --skill typescript-docs-alonronin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation of high-quality, multi-audience TypeScript documentation, ensuring clarity and maintainability for complex projects.

Core Features & Use Cases

API Documentation: Generate API docs using TypeDoc.
Code Examples: Provide runnable code examples for functions and components.
Architectural Decision Records (ADRs): Document key architectural choices.
Use Case: Documenting a new NestJS microservice with detailed API references, code examples for key endpoints, and ADRs for major architectural decisions.

Quick Start

Use the typescript-docs skill to generate API documentation for the 'src/index.ts' entry point.

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 documentation for a NestJS microservice?▼

Generate TypeScript API documentation using TypeDoc, JSDoc annotations, and multi-layered patterns. It supports creating API references, runnable code examples, and architectural decision records for frameworks like NestJS, Express, React, Angular, and Vue.

What's the best way to document architectural decisions in a TypeScript project?▼

Document architectural decisions by generating Architectural Decision Records. This Skill supports creating ADRs alongside API documentation and code examples to capture key architectural choices for maintainability and clarity.

Do I need TypeDoc and ESLint to generate TypeScript API documentation?▼

Yes, you need TypeDoc to generate TypeScript API documentation and ESLint for validation. These dependencies are required to support the multi-layered documentation patterns and ensure code quality compliance.

Can I use JSDoc to create comprehensive API docs for React and Angular components?▼

Yes, you can use JSDoc to create comprehensive API docs for React and Angular components. The Skill supports framework-specific documentation patterns for NestJS, Express, React, Angular, and Vue, including runnable code examples.

How does multi-layered TypeScript documentation work for different audiences?▼

Multi-layered TypeScript documentation works by generating tailored outputs for different audiences: API references via TypeDoc for developers, runnable code examples for implementers, and ADRs for stakeholders. This ensures clarity across complex projects.