Changelogs
Post product updates in your docs with a subscribable RSS feed
Create a changelog for your docs by adding Update components to a page.
Check out the Mintlify changelog as an example: you can include links, images, text, and demos of your new features in each update.
Setting up your changelog
Create a page for your changelog
- Create a new page in your docs such as
changelog.mdx
orupdates.mdx
. - Add your changelog page to your navigation scheme in your
docs.json
.
Add Update components to your changelog
Add an Update
for each changelog entry.
Include relevant information like feature releases, bug fixes, or other announcements.
Customizing your changelog
Control how people navigate your changelog and stay up to date with your product information.
Table of contents
Each label
property for an Update
automatically creates an entry in the right sidebar’s table of contents. This is the default navigation for your changelog.
Tag filters
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:
The table of contents and changelog filters are hidden when using custom
, center
, or wide
page modes. Learn more about page modes.
Subscribable changelogs
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.
RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include:
- Slack
- Email via Zapier
- Discord bots like Readybot or RSS Feeds to Discord Bot
To make the RSS feed discoverable, you can display an RSS icon button that links to the feed at the top of the page. Add rss: true
to the page frontmatter: