rspress-api-docs
OfficialTurn TS APIs into clear docs.
Authorsavvy-web
Version1.0.0
Installs0
System Documentation
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).
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: rspress-api-docs Download link: https://github.com/savvy-web/developer-docs/archive/main.zip#rspress-api-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.