skills.rest
Fabric-Pro
Fabric-ProOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation-generation

Generate API references, READMEs, changelogs, and documentation sites from code.

3|Updated Aug 26, 2026
Search Tags:#changelog#documentation#openapi#jsdoc#docusaurus#typedoc#vitepress
One-click install
npx skills add https://github.com/Fabric-Pro/fabric-oss --skill documentation-generation-fabric-pro
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generation
Source: https://github.com/Fabric-Pro/fabric-oss/tree/main/.cursor/skills/documentation-generation
Command: npx skills add https://github.com/Fabric-Pro/fabric-oss --skill documentation-generation-fabric-pro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping technical documentation accurate and complete is time-consuming, and docs quickly drift out of sync with code. This Skill provides templates, tooling patterns, and checklists for producing API references, READMEs, changelogs, and full documentation sites. ## Core Features & Use Cases - API Documentation: Generate OpenAPI/Swagger specs from JSDoc annotations, TypeDoc references from TypeScript, and self-documenting GraphQL schemas. - Project Documentation: Produce structured README files, Keep a Changelog-compliant CHANGELOGs, and JSDoc comments for public APIs. - Documentation Sites: Build static doc sites with VitePress or Docusaurus, plus CI checks for broken links and tested code examples. - Use Case: When shipping a new TypeScript library, use this Skill to write the README, annotate public functions with JSDoc, generate a TypeDoc API reference, and scaffold a VitePress site with navigation. ## Quick Start Generate a README, JSDoc-annotated API reference, and a VitePress documentation site for my TypeScript project.

Frequently Asked Questions about documentation-generation

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

FAQPage Schema
How do I generate API documentation from JSDoc comments?▼

Add @swagger JSDoc annotations above your route handlers describing endpoints, parameters, and schemas, then use swagger-jsdoc with swagger-ui-express to serve an interactive OpenAPI UI. For TypeScript libraries, TypeDoc generates reference docs directly from JSDoc comments.

VitePress vs Docusaurus for documentation sites?▼

VitePress is a lightweight Vue-based static site generator suited for fast, Markdown-centric docs with simple config. Docusaurus is React-based and better when you need blogs, versioning, and richer plugin ecosystems.

Does TypeDoc support Markdown output?▼

Yes, TypeDoc supports Markdown output through the typedoc-plugin-markdown plugin. Configure it in typedoc.json with the plugin entry, set entryPoints to your source index, and run npx typedoc to generate the docs.

How do I keep code examples in documentation from breaking?▼

Extract code blocks from Markdown files in a test suite and execute or type-check them in CI. Combine this with a link-checking GitHub Action such as markdown-link-check to catch broken links on every push.

What format should a CHANGELOG follow?▼

Follow the Keep a Changelog format with Semantic Versioning, grouping entries under Added, Changed, Deprecated, Removed, Fixed, and Security. Include migration guides for breaking changes so users can upgrade safely.

Related Skills

Explore More Software Engineering Skills→
NAMEWTANAMEWTA
2

api-and-interface-design

Designs stable REST APIs, TypeScript contracts, and module boundaries with consistent error semantics.

Community
Intermediate
openonionopenonion
1.3k

ship-feature

Automate end-to-end feature releases from code changes to PyPI.

Official
Advanced
terrylicaterrylica
62

adr-code-traceability

Add ADR references to code with language-specific comment patterns.

Community
Basic
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced