rspress-api-docs

Generate RSPress API documentation from TypeScript source files.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/savvy-web/developer-docs --skill rspress-api-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rspress-api-docs
Source: https://github.com/savvy-web/developer-docs/tree/main/.claude/skills/rspress-api-docs
Command: npx skills add https://github.com/savvy-web/developer-docs --skill rspress-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams document TypeScript API surfaces for RSPress projects. It guides documenting package APIs, extracting type signatures, and creating function/class reference pages, reducing manual drafting and keeping docs in sync with code.

Core Features & Use Cases

  • Manual Documentation Workflow: Read source files, extract type signatures, and write structured markdown pages for API references.
  • API Directory Structure: API reference pages live under docs/src/en/packages/@savvy-web/{package}/api/, organized into functions, types, and classes.
  • Real-World Use Case: When you add a new export in a package, generate or update its API docs automatically as part of a simple workflow.

Quick Start

Create or update API pages for a package's exports, placing them in the appropriate docs/src/en/packages/@savvy-web/{package}/api/ subfolders (functions, types, classes).

Frequently Asked Questions about rspress-api-docs

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

FAQPage Schema
How do I generate API documentation from TypeScript source code?

API documentation generation from TypeScript extracts type signatures and JSDoc comments from source files, then produces structured markdown reference pages. This Skill automates that workflow for RSPress projects by reading exports, identifying types and functions, and writing organized API docs under a docs directory.

Can I automatically create API reference pages when I add new TypeScript exports?

Yes. This Skill implements a manual documentation workflow that locates source files, identifies exports, extracts type signatures, and writes markdown pages for functions, types, and classes. It keeps API docs synchronized with code changes as part of a simple update process.

What's the best way to organize TypeScript API documentation in RSPress?

Organize API reference pages under `docs/src/en/packages/@savvy-web/{package}/api/`, grouped into subfolders for functions, types, and classes. This Skill structures markdown pages with navigable indexes, making API surfaces discoverable and maintainable within RSPress projects.

Does this work for documenting package APIs with complex type signatures?

Yes. The Skill extracts and documents full type signatures and JSDoc from TypeScript source files, handling functions, classes, and type definitions. It captures the complete API surface, enabling clear reference pages for packages with advanced type structures.

How do I keep TypeScript API docs in sync with code changes?

This Skill guides a manual workflow to regenerate or update API documentation whenever exports change. By extracting current type signatures and JSDoc directly from source files, it ensures reference pages reflect the latest API without manual drafting.