Skip to content

Commit 6dbe1d1

Browse files
authored
RSS changelogs v2 (#930)
* remove `rss` object from Update page * update changelog info * update example RSS feed
1 parent 4143274 commit 6dbe1d1

File tree

2 files changed

+24
-46
lines changed

2 files changed

+24
-46
lines changed

components/update.mdx

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Use the `Update` component to display changelog entries, version updates, and re
2929

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

@@ -49,28 +48,3 @@ Use multiple `Update` components to create [changelogs](/guides/changelogs).
4948
<ResponseField name="description" type="string">
5049
Description of the update. Appears below the label and tag.
5150
</ResponseField>
52-
53-
<ResponseField name="rss" type="object">
54-
Title and description that will appear in the RSS feed entry for the update.
55-
56-
```mdx wrap
57-
<Update label="v1.0.1" rss={{ title: "v1.0.1 released", description: "Bug fixes and improvements" }}>
58-
# What's New in v1.0.1
59-
60-
* Bug fixes
61-
* Improvements
62-
</Update>
63-
```
64-
65-
```xml Example Update item in RSS feed
66-
<item>
67-
<title><![CDATA[v1.0.1 released]]></title>
68-
<description><![CDATA[Bug fixes and improvements]]></description>
69-
<link>https://mintlify.com/changelog#v101</link>
70-
<guid isPermaLink="true">https://mintlify.com/changelog#v101</guid>
71-
<pubDate>Fri, 20 Jun 2025 21:32:19 GMT</pubDate>
72-
</item>
73-
```
74-
75-
Learn more about [subscribable changelogs](/guides/changelogs#subscribable-changelogs).
76-
</ResponseField>

guides/changelogs.mdx

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -100,27 +100,31 @@ Add `tags` to your `Update` components to replace the table of contents with tag
100100

101101
### Subscribable changelogs
102102

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.
103+
Using `Update` components creates a subscribable RSS feed at your page URL with `/rss.xml` appended. For example, `mintlify.com/docs/changelog/rss.xml`.
104+
105+
Entries are added to the RSS feed when new `Update` components are published and when new headings are added inside of existing `<Update>` tags.
106+
107+
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.
104108

105109
```xml Example RSS feed
106-
<?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">
107-
<channel>
108-
<title><![CDATA[Product Updates]]></title>
109-
<description><![CDATA[New updates and improvements]]></description>
110-
<link>https://mintlify-changelogs-guide.mintlify.app</link>
111-
<generator>RSS for Node</generator>
112-
<lastBuildDate>Fri, 20 Jun 2025 21:36:14 GMT</lastBuildDate>
113-
<atom:link href="https://mintlify-changelogs-guide.mintlify.app/changelog/rss.xml" rel="self" type="application/rss+xml"/>
114-
<copyright><![CDATA[Mintlify]]></copyright>
115-
<docs>https://mintlify-changelogs-guide.mintlify.app</docs>
116-
<item>
117-
<title><![CDATA[Subscribable changelogs]]></title>
118-
<description><![CDATA[Post product updates in your docs with a subscribable RSS feed]]></description>
119-
<link>https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025</link>
120-
<guid isPermaLink="true">https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025</guid>
121-
<pubDate>Fri, 20 Jun 2025 21:04:47 GMT</pubDate>
122-
</item>
123-
</channel>
110+
<?xml version="1.0" encoding="UTF-8"?>
111+
<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">
112+
<channel>
113+
<title><![CDATA[Product updates]]></title>
114+
<description><![CDATA[New updates and improvements]]></description>
115+
<link>https://mintlify.com/docs</link>
116+
<generator>RSS for Node</generator>
117+
<lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
118+
<atom:link href="https://mintlify.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
119+
<copyright><![CDATA[Mintlify]]></copyright>
120+
<docs>https://mintlify.com/docs</docs>
121+
<item>
122+
<title><![CDATA[June 2025]]></title>
123+
<link>https://mintlify.com/docs/changelog#june-2025</link>
124+
<guid isPermaLink="true">https://mintlify.com/docs/changelog#june-2025</guid>
125+
<pubDate>Mon, 23 Jun 2025 16:54:22 GMT</pubDate>
126+
</item>
127+
</channel>
124128
</rss>
125129
```
126130

0 commit comments

Comments
 (0)