Skip to content

Updating update.mdx #620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2025
Merged

Updating update.mdx #620

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions content/components/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: "rectangle-history"

The `Update` component is used to keep track of changes and updates.

<Update label="2024-10-12" description="v0.1.1">
<Update label="2024-10-12" description="v0.1.1" tags={["Filter 1"]}>
<Frame>
<img
className="block"
Expand All @@ -23,14 +23,14 @@ The `Update` component is used to keep track of changes and updates.
- Sticky section for each changelog
</Update>

<Update label="2024-10-11" description="v0.1.0">
<Update label="2024-10-11" description="v0.1.0" tags={["Filter 2"]}>
### How to use
```md
<Update label="2024-10-12" description="v0.1.1">
<Update label="2024-10-12" description="v0.1.1" tags={["Filter 1"]}>
This is how you use a changelog with a label
and a description.
</Update>
<Update label="2024-10-11" description="v0.1.0">
<Update label="2024-10-11" description="v0.1.0" tags={["Filter 2"]}>
This is how you use a changelog with a label
and a description.
</Update>
Expand All @@ -46,14 +46,16 @@ The `Update` component is used to keep track of changes and updates.
## Props

<ResponseField name="label" type="string" required>
Label in the changelog, on the sticky left side.
The label give to the update, appears as sticky text to the left of the changelog.
</ResponseField>

<ResponseField name="description" type="string">
Description below the label in the Changelog preview.
<ResponseField name="tags" type="string[]">
Tags for the changelog, will be shown as filters in the right side panel.
</ResponseField>

<ResponseField name="tags" type="string[]">
Tags for the changelog, will be show as filters in the right side panel
<ResponseField name="description" type="string">
Description of the update, appears below the label and tag.
</ResponseField>