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
or updates.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.
---
title: "Changelog"
description: "Product updates and announcements"
---
<Update label="March 2025" description="v0.0.10">
Added a new Wintergreen flavor.
Released a new version of the Spearmint flavor, now with 10% more mint.
</Update>
<Update label="February 2025" description="v0.0.09">
Released a new version of the Spearmint flavor.
</Update>
Customizing your changelog
Control how people navigate your changelog and stay up to date with your product information.
Table of contents
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:
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:
<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
Added a new Wintergreen flavor.
Released a new version of the Spearmint flavor, now with 10% more mint.
</Update>
<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
Released a new version of the Spearmint flavor.
</Update>
<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
Deprecated the Peppermint flavor.
Released a new version of the Spearmint flavor.
</Update>
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.
<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
<channel>
<title><![CDATA[Product Updates]]></title>
<description><![CDATA[New updates and improvements]]></description>
<link>https://mintlify-changelogs-guide.mintlify.app</link>
<generator>RSS for Node</generator>
<lastBuildDate>Fri, 20 Jun 2025 21:36:14 GMT</lastBuildDate>
<atom:link href="https://mintlify-changelogs-guide.mintlify.app/changelog/rss.xml" rel="self" type="application/rss+xml"/>
<copyright><![CDATA[Mintlify]]></copyright>
<docs>https://mintlify-changelogs-guide.mintlify.app</docs>
<item>
<title><![CDATA[Subscribable changelogs]]></title>
<description><![CDATA[Post product updates in your docs with a subscribable RSS feed]]></description>
<link>https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025</link>
<guid isPermaLink="true">https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025</guid>
<pubDate>Fri, 20 Jun 2025 21:04:47 GMT</pubDate>
</item>
</channel>
</rss>
RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include:
To add RSS feed links to your page’s contextual menu, add the rss
property to your docs.json
:
"rss": {
"pages": ["changelog", "status"]
}