create-documentation
Document a new or existing design system component
Installation
Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.
Voir la source ↗GuidesInstructions
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 |
❌ |
Exemples
Consultez les exemples du dépôt source.
Voir la source ↗Historique source
- Date d’indexation
- 2026-01-20
- Mise à jour de l’index
- 2026-01-28
- Branch
- main
Les dates concernent ce répertoire. Consultez le dépôt pour l’historique du code.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!