Skip to content

Commit fa144c5

Browse files
committed
Update update component page
1 parent fe21530 commit fa144c5

File tree

1 file changed

+25
-42
lines changed

1 file changed

+25
-42
lines changed

components/update.mdx

Lines changed: 25 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,58 @@
11
---
22
title: "Update"
33
description: "Keep track of changes and updates"
4-
icon: 'list-collapse'
4+
icon: "list-collapse"
55
---
66

7-
The `Update` component is used to keep track of changes and updates.
7+
Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting.
88

9-
<Update label="2024-10-12" description="v0.1.1">
9+
<Update label="Example" description="v0.1.1">
10+
## Example update
11+
12+
You can add anything here, like a screenshot, a code snippet, or a list of changes.
13+
1014
<Frame>
1115
<img
1216
className="block"
1317
src="https://mintlify-assets.b-cdn.net/hero-light.png"
18+
alt=""
1419
/>
1520
</Frame>
1621

17-
## Changelog
18-
19-
You can add anything here, like a screenshot, a code snippet, or a list of changes.
20-
21-
#### Features
22+
### Features
2223
- Responsive design
23-
- Sticky section for each changelog
24+
- Anchor for each update
2425
</Update>
2526

26-
<Update label="2024-10-11" description="v0.1.0">
27-
### How to use
28-
```mdx
29-
<Update label="2024-10-12" description="v0.1.1">
30-
This is how you use a changelog with a label
31-
and a description.
32-
</Update>
33-
<Update label="2024-10-11" description="v0.1.0">
34-
This is how you use a changelog with a label
35-
and a description.
36-
</Update>
37-
```
27+
## How to use
3828

39-
You can use multiple `Update` components to create changelogs.
29+
```mdx Update example
30+
<Update label="2024-10-12" description="v0.1.1">
31+
This is how you use a changelog with a label
32+
and a description.
4033
</Update>
34+
<Update label="2024-10-11" description="v0.1.0">
35+
This is how you use a changelog with a label
36+
and a description.
37+
</Update>
38+
```
4139

42-
<Tip>
43-
Each `label` creates an anchor and also shows up on the table of contents on the right.
44-
</Tip>
40+
Use multiple `Update` components to create changelogs. Each `label` creates an anchor and an item in the table of contents.
4541

4642
## Props
4743

4844
<ResponseField name="label" type="string" required>
49-
The label give to the update, appears as sticky text to the left of the changelog.
45+
Label for the update. Appears to the left of the update and creates an anchor link.
5046
</ResponseField>
5147

5248
<ResponseField name="tags" type="string[]">
53-
Tags for the changelog, will be shown as filters in the right side panel.
49+
Tags for the update. Shown as filters in the right side panel.
5450
</ResponseField>
5551

5652
<ResponseField name="description" type="string">
57-
Description of the update, appears below the label and tag.
53+
Description of the update. Appears below the label and tag.
5854
</ResponseField>
5955

60-
6156
<ResponseField name="rss" type="object: { title: string; description: string; }">
62-
Title and description how you would like for them to appear in generated RSS feeds for this update. Learn more about [subscribable changelogs](/guides/changelogs).
57+
Includes this update in RSS feeds for subscribers. Specify the title and description that will appear in the RSS feed entry. Learn more about [subscribable changelogs](/guides/changelogs).
6358
</ResponseField>
64-
65-
66-
<RequestExample>
67-
68-
```mdx Update Example
69-
<Update label="2024-10-12" description="v0.1.1">
70-
This is how you use a changelog with a label
71-
and a description.
72-
</Update>
73-
```
74-
75-
</RequestExample>

0 commit comments

Comments
 (0)