create-documentation
Document a new or existing design system component
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Create Documentation
After creating a component in the "ui" package, always create a corresponding docs MDX file with the following structure. Comments in this example are instructions for you to fill in information.
## Overview
<!-- Provide a brief description about what the component is and where it might be used. -->
## Usage
Import the component:
```ts
import { COMPONENTNAME } from '@eqtylab/equality';
```
Basic usage with required properties:
// Give a minimal example of the component's usage with all required properties
Variants
Variant Subheadings
Slots
| Name | Description |
|---|
Props
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
propname |
Concise one line description | boolean |
True | ✅ |
enumexample |
If a prop is an enum | neutral, primary, success, etc |
neutral |
❌ |
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-28
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!