Skip to content

Commit 4e00526

Browse files
committed
start changelogs guide
1 parent 91a48c9 commit 4e00526

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

guides/changelogs.mdx

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "Changelogs"
3+
description: "Post product updates in your docs with a subscribable RSS feed"
4+
icon: "newspaper"
5+
---
6+
7+
Adding a changelog page to your docs is as simple as adding an MDX file with [Update components](/components/update).
8+
9+
Check out the [Mintlify changelog](/changelog) as an example: you can include links, images and text content, and demos of your new product features in each update.
10+
11+
# Tag filters
12+
13+
Adding tags to your Update components will make a tag list appear on the right side of your changelog document which can be used for filtering Update items:
14+
15+
```mdx
16+
<Update label="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
17+
Lorem ipsum dolor sit amet, consectetur adipiscing elit...
18+
</Update>
19+
20+
<Update label="v0.0.09" tags={["Spearmint"]}>
21+
Nam fermentum ultricies ipsum, pellentesque pellentesque purus facilisis non...
22+
</Update>
23+
24+
<Update label="v0.0.08" tags={["Wintergreen", "Peppermint"]}>
25+
Donec viverra risus lacinia, tincidunt magna mattis, pulvinar magna...
26+
</Update>
27+
```
28+
29+
![Changelogs with filters](/images/changelog-filters-1.png)
30+
![Changelogs with activated filters](/images/changelog-filters-2.png)
31+
32+
# Subscribable changelogs
33+
34+
Using the Update component on your changelog page also automatically creates a subscribable RSS feed for your changes at the page URL + "/rss.xml"
35+
36+
After publishing a new Update on the page, it will be automatically included in the RSS feed for that page. RSS feeds can be integrated with Slack, email, or other subscription tools for your users.
37+
38+
You can customize the text included for each Update item with the feedTitle and feedUpdate properties:
39+
40+
```mdx
41+
<Update label="v0.0.10" rss={title: "Version 0.0.10 is now live", description: "Including updates to AI models and more"} feedDescription=>
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit...
43+
</Update>
44+
```
45+

images/changelog-filters-1.png

440 KB
Loading

images/changelog-filters-2.png

348 KB
Loading

0 commit comments

Comments
 (0)