Skip to content

Commit ea32326

Browse files
ethanpalmethanpalm
committed
update procedural sections
1 parent d32182c commit ea32326

File tree

1 file changed

+69
-18
lines changed

1 file changed

+69
-18
lines changed

‎guides/changelogs.mdx‎

Lines changed: 69 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,43 @@ Create a changelog for your docs by adding [Update components](/components/updat
88

99
Check out the [Mintlify changelog](/changelog) as an example: you can include links, images, text, and demos of your new features in each update.
1010

11-
## Table of contents
11+
## Setting up your changelog
1212

13-
Each `Update` element label is automatically used to create a table of contents on the right side of the page:
13+
<Steps>
14+
<Step title="Create a page for your changelog">
15+
1. Create a new page in your docs such as `changelog.mdx` or `updates.mdx`.
16+
2. Add your changelog page to your navigation scheme in your `docs.json`.
17+
</Step>
18+
<Step title="Add Update components to your changelog">
19+
Add an `Update` for each changelog entry.
20+
21+
Include relevant information like feature releases, bug fixes, or other announcements.
22+
</Step>
23+
</Steps>
24+
25+
```mdx Example changelog.mdx
26+
---
27+
title: "Changelog"
28+
description: "Product updates and announcements"
29+
---
30+
<Update label="March 2025" description="v0.0.10">
31+
Added a new Wintergreen flavor.
32+
33+
Released a new version of the Spearmint flavor, now with 10% more mint.
34+
</Update>
35+
36+
<Update label="February 2025" description="v0.0.09">
37+
Released a new version of the Spearmint flavor.
38+
</Update>
39+
```
40+
41+
## Customizing your changelog
42+
43+
Control how people navigate your changelog and stay up to date with your product information.
44+
45+
### Table of contents
46+
47+
Each `label` for an `Update` automatically creates an entry in the right sidebar's table of contents. This is the default navigation for your changelog:
1448

1549
<Frame>
1650
<img
@@ -25,43 +59,60 @@ Each `Update` element label is automatically used to create a table of contents
2559
/>
2660
</Frame>
2761

28-
## Tag filters
62+
### Tag filters
63+
64+
Add `tags` to your `Update` components to replace the table of contents with tag filters. Users can filter the changelog by selecting one or more tags:
2965

30-
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 entries:
66+
```mdx Tag filters example wrap
67+
<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
68+
Added a new Wintergreen flavor.
3169

32-
```mdx
33-
<Update label="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
34-
Lorem ipsum dolor sit amet, consectetur adipiscing elit...
70+
Released a new version of the Spearmint flavor, now with 10% more mint.
3571
</Update>
3672

37-
<Update label="v0.0.09" tags={["Spearmint"]}>
38-
Nam fermentum ultricies ipsum, pellentesque pellentesque purus facilisis non...
73+
<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
74+
Released a new version of the Spearmint flavor.
3975
</Update>
4076

41-
<Update label="v0.0.08" tags={["Wintergreen", "Peppermint"]}>
42-
Donec viverra risus lacinia, tincidunt magna mattis, pulvinar magna...
77+
<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
78+
Deprecated the Peppermint flavor.
79+
80+
Released a new version of the Spearmint flavor.
4381
</Update>
4482
```
4583

46-
<Frame caption="Tag filters">
47-
![Changelogs with activated filters](/images/changelog-filters-2.png)
84+
<Frame>
85+
<img
86+
src="/images/changelog-filters-light.png"
87+
alt="Changelog in light mode with the Peppermint tag filter selected."
88+
className="block dark:hidden"
89+
/>
90+
<img
91+
src="/images/changelog-filter-dark.png"
92+
alt="Changelog in dark mode with the Peppermint tag filter selected."
93+
className="hidden dark:block"
94+
/>
4895
</Frame>
4996

5097
<Tip>
51-
Some page settings may automatically hide the table of contents and changelog filters: when your page has mode: 'custom', 'center', or 'wide'. Learn more about [page modes](/pages#page-mode).
98+
The table of contents and changelog filters are hidden when using `custom`, `center`, or `wide` page modes. Learn more about [page modes](/pages#page-mode).
5299
</Tip>
53100

54-
## Subscribable changelogs
101+
### Subscribable changelogs
55102

56-
Using the `Update` component on your changelog page also automatically creates a subscribable RSS feed for your changes at the page URL + "/rss.xml".
103+
Using `Update` components creates a subscribable RSS feed at your page URL + `/rss.xml`. For example, `mintlify.com/docs/changelog/rss.xml`. New updates are automatically included in the feed when published.
57104

58105
<div style={{ border: '2px solid #ff00ff' }}>
59106
TODO: insert XML screenshot
60107
</div>
61108

62-
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.
109+
RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include:
110+
111+
* [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack)
112+
* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier
113+
* Discord bots like [Readybot](https://readybot.io) or [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot)
63114

64-
The `"rss"` property in docs.json accepts an array of pages where the RSS feed link will be added to the contextual menu:
115+
To add RSS feed links to your page's [contextual menu](ai-ingestion#contextual-menu), add the `rss` property to your `docs.json`:
65116

66117
```json
67118
"rss": {

0 commit comments

Comments
 (0)