typescript-docs

Generate TypeScript API documentation with TypeDoc and architectural decision records.

2|Updated Jan 5, 2024
One-click install
npx skills add https://github.com/wilfriedago/dotfiles --skill typescript-docs-wilfriedago
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/wilfriedago/dotfiles/tree/main/agents/skills/typescript-docs
Command: npx skills add https://github.com/wilfriedago/dotfiles --skill typescript-docs-wilfriedago

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typedoc, typedoc-plugin-markdown, @compodoc/compodoc, and includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation of high-quality, multi-audience TypeScript documentation, ensuring code is well-understood and maintainable.

Core Features & Use Cases

  • API Documentation: Generates API reference docs using TypeDoc.
  • Architectural Decision Records (ADRs): Documents key architectural choices.
  • Code Examples: Provides clear, runnable code snippets.
  • Use Case: Automatically generate and update the API documentation for your TypeScript library whenever new code is merged, ensuring developers always have access to accurate information.

Quick Start

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

Frequently Asked Questions about typescript-docs

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

FAQPage Schema
How do I generate API reference documentation for a TypeScript project?

Generate API reference documentation by running the typescript-docs skill on source files like 'src/index.ts', which uses TypeDoc to automatically extract types, JSDoc comments, and module structures into comprehensive API references.

Can I use TypeDoc to generate documentation for NestJS or Express frameworks?

Yes, the documentation generation pipeline supports frameworks like NestJS, Express, React, Angular, and Vue, automatically adapting the TypeDoc and JSDoc extraction patterns to fit various framework-specific architectural structures.

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

The best way to document architectural decisions is by generating Architectural Decision Records (ADRs), which capture key architectural choices alongside your standard API documentation to maintain long-term codebase clarity and understanding.

Does this documentation generation approach support JSDoc best practices?

Yes, the automated documentation pipeline enforces JSDoc best practices, ensuring that inline code comments are accurately parsed and formatted into clear, runnable code examples and structured API references.

How do I set up an automated documentation pipeline for TypeScript libraries?

Set up an automated documentation pipeline by integrating the skill into your build process to automatically generate and update TypeDoc API references and layered documentation whenever new TypeScript code is merged.

Can I generate layered documentation patterns for different audiences from TypeScript?

Yes, the skill generates layered documentation patterns tailored for various audiences, combining high-level architectural decision records with detailed API references and runnable code examples to serve both developers and maintainers.