majiayu000 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 |
❌ |