typescript-docs
Clear API docs for your TypeScript project.
What it does
Creates API references, inline comments, and architectural decision records for TypeScript projects.
When to use it
Use when creating API documentation, architectural decision records, code examples, or documentation for the listed frameworks.
How to use it
Give it a TypeScript project and a documentation request; it creates project documentation and supporting configuration.
What you provide
- An existing project
Uses
What you need · 3
The documentation pipeline uses Node.js; the main workflow example configures version 20.
Uses ESLint to validate documentation and requires fixing validation errors before committing.
GitHub repository access enables the expanded workflow that pushes generated documentation and publishes it to GitHub Pages.
Access · 1
This skill
GitHub
Publishes documentation on GitHub