Skip to content

RSS changelogs v2 #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2025
Merged

RSS changelogs v2 #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a01d29
remove `rss` object from Update page
ethanpalm Jul 21, 2025
4726087
update changelog info
ethanpalm Jul 21, 2025
a7bc940
update example RSS feed
ethanpalm Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 1 addition & 27 deletions components/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Use the `Update` component to display changelog entries, version updates, and re

```mdx Update example
<Update label="2024-10-11" description="v0.1.0" tags={["Mintlify"]}>
This is how you use a changelog with a label, description,
and tags.
This is an update with a label, description, and tag.
</Update>
```

Expand All @@ -49,28 +48,3 @@ Use multiple `Update` components to create [changelogs](/guides/changelogs).
<ResponseField name="description" type="string">
Description of the update. Appears below the label and tag.
</ResponseField>

<ResponseField name="rss" type="object">
Title and description that will appear in the RSS feed entry for the update.

```mdx wrap
<Update label="v1.0.1" rss={{ title: "v1.0.1 released", description: "Bug fixes and improvements" }}>
# What's New in v1.0.1

* Bug fixes
* Improvements
</Update>
```

```xml Example Update item in RSS feed
<item>
<title><![CDATA[v1.0.1 released]]></title>
<description><![CDATA[Bug fixes and improvements]]></description>
<link>https://mintlify.com/changelog#v101</link>
<guid isPermaLink="true">https://mintlify.com/changelog#v101</guid>
<pubDate>Fri, 20 Jun 2025 21:32:19 GMT</pubDate>
</item>
```

Learn more about [subscribable changelogs](/guides/changelogs#subscribable-changelogs).
</ResponseField>
42 changes: 23 additions & 19 deletions guides/changelogs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Changelogs"
description: "Post product updates in your docs with a subscribable RSS feed"

Check warning on line 3 in guides/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/changelogs.mdx#L3 

Did you really mean 'subscribable'?
icon: "newspaper"
---

Expand Down Expand Up @@ -98,39 +98,43 @@
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).
</Tip>

### Subscribable changelogs

Check warning on line 101 in guides/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/changelogs.mdx#L101 

Did you really mean 'Subscribable'?

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.
Using `Update` components creates a subscribable RSS feed at your page URL with `/rss.xml` appended. For example, `mintlify.com/docs/changelog/rss.xml`.

Check warning on line 103 in guides/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/changelogs.mdx#L103 

Did you really mean 'subscribable'?

Entries are added to the RSS feed when new `Update` components are published and when new headings are added inside of existing `<Update>` tags.

The top level headings of `Update` components are used as the titles of RSS feed entries, and the entries link to their heading anchors in your docs.

```xml Example RSS feed
<?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>
<?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.com/docs</link>
<generator>RSS for Node</generator>
<lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
<atom:link href="https://mintlify.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
<copyright><![CDATA[Mintlify]]></copyright>
<docs>https://mintlify.com/docs</docs>
<item>
<title><![CDATA[June 2025]]></title>
<link>https://mintlify.com/docs/changelog#june-2025</link>
<guid isPermaLink="true">https://mintlify.com/docs/changelog#june-2025</guid>
<pubDate>Mon, 23 Jun 2025 16:54:22 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:

* [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack)
* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier

Check warning on line 134 in guides/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/changelogs.mdx#L134 

Did you really mean 'Zapier'?
* Discord bots like [Readybot](https://readybot.io) or [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-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:

Check warning on line 137 in guides/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/changelogs.mdx#L137 

Did you really mean 'frontmatter'?

```mdx
---
Expand Down