component-doc

Community

Automatically document Skyroc Web UI components.

AuthorOhh-889
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automatically generates and updates MDX documentation for Skyroc Web UI components by aligning source, playground demos, and existing docs into a consistent component-docs structure.

Core Features & Use Cases

  • Automatic discovery of component sources, demos, and documentation across mono-repo layout.
  • MDX generation and synchronization with apps/web-ui-docs content guidelines, including props/type tables and live demos.
  • Use case: when a new component like Button is added or an existing one changes, generate or refresh its docs automatically to reflect the latest API and examples.

Quick Start

Create or refresh the MDX documentation for a given component by locating its source, playground, and existing docs, then update apps/web-ui-docs/content/docs/components/<slug>.mdx.

Dependency Matrix

Required Modules

None required

Components

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: component-doc
Download link: https://github.com/Ohh-889/skyroc-admin/archive/main.zip#component-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.