packages-documentation
OfficialCreate clear, consistent API docs and guides.
Software Engineering#documentation#getting-started#api-reference#api-docs#docs-writing#migration-guides#deprecation-notices
Authorreactive
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Write, update, and format documentation for public library interfaces, ensuring API references, READMEs, docstrings, usage examples, migration guides, and deprecation notices are complete and consistent.
Core Features & Use Cases
- Structured documentation per package with sections: api/, guides/, concepts/, getting-started/.
- Enforces frontmatter metadata (title, sidebar_label) for API doc files and ensures consistent naming between code and docs.
- Provides guidelines for migrating guides and deprecation notices to help teams communicate changes and transition paths.
Quick Start
Create a documentation structure under docs/{package}/ with api/, guides/, and concepts/ folders and populate each file using the prescribed frontmatter and content guidelines.
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: packages-documentation Download link: https://github.com/reactive/data-client/archive/main.zip#packages-documentation 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.