|
1 | 1 | --- |
2 | 2 | title: "Update" |
3 | 3 | description: "Keep track of changes and updates" |
4 | | -icon: 'list-collapse' |
| 4 | +icon: "list-collapse" |
5 | 5 | --- |
6 | 6 |
|
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. |
8 | 8 |
|
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 | + |
10 | 14 | <Frame> |
11 | 15 | <img |
12 | 16 | className="block" |
13 | 17 | src="https://mintlify-assets.b-cdn.net/hero-light.png" |
| 18 | + alt="" |
14 | 19 | /> |
15 | 20 | </Frame> |
16 | 21 |
|
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 |
22 | 23 | - Responsive design |
23 | | - - Sticky section for each changelog |
| 24 | + - Anchor for each update |
24 | 25 | </Update> |
25 | 26 |
|
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 |
38 | 28 |
|
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. |
40 | 33 | </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 | +``` |
41 | 39 |
|
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. |
45 | 41 |
|
46 | 42 | ## Props |
47 | 43 |
|
48 | 44 | <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. |
50 | 46 | </ResponseField> |
51 | 47 |
|
52 | 48 | <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. |
54 | 50 | </ResponseField> |
55 | 51 |
|
56 | 52 | <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. |
58 | 54 | </ResponseField> |
59 | 55 |
|
60 | | - |
61 | 56 | <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). |
63 | 58 | </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