diff --git a/components/update.mdx b/components/update.mdx index 1f7fa57fa..6e13f200c 100644 --- a/components/update.mdx +++ b/components/update.mdx @@ -29,8 +29,7 @@ Use the `Update` component to display changelog entries, version updates, and re ```mdx Update example - This is how you use a changelog with a label, description, - and tags. + This is an update with a label, description, and tag. ``` @@ -49,28 +48,3 @@ Use multiple `Update` components to create [changelogs](/guides/changelogs). Description of the update. Appears below the label and tag. - - - Title and description that will appear in the RSS feed entry for the update. - - ```mdx wrap - - # What's New in v1.0.1 - - * Bug fixes - * Improvements - - ``` - -```xml Example Update item in RSS feed - - <![CDATA[v1.0.1 released]]> - - https://mintlify.com/changelog#v101 - https://mintlify.com/changelog#v101 - Fri, 20 Jun 2025 21:32:19 GMT - -``` - - Learn more about [subscribable changelogs](/guides/changelogs#subscribable-changelogs). - diff --git a/guides/changelogs.mdx b/guides/changelogs.mdx index 168b6fc6f..3b475121d 100644 --- a/guides/changelogs.mdx +++ b/guides/changelogs.mdx @@ -100,27 +100,31 @@ Add `tags` to your `Update` components to replace the table of contents with tag ### 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. +Using `Update` components creates a subscribable RSS feed at your page URL with `/rss.xml` appended. For example, `mintlify.com/docs/changelog/rss.xml`. + +Entries are added to the RSS feed when new `Update` components are published and when new headings are added inside of existing `` 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 - - - <![CDATA[Product Updates]]> - - https://mintlify-changelogs-guide.mintlify.app - RSS for Node - Fri, 20 Jun 2025 21:36:14 GMT - - - https://mintlify-changelogs-guide.mintlify.app - - <![CDATA[Subscribable changelogs]]> - - https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025 - https://mintlify-changelogs-guide.mintlify.app/changelog#june-20-2025 - Fri, 20 Jun 2025 21:04:47 GMT - - + + + + <![CDATA[Product updates]]> + + https://mintlify.com/docs + RSS for Node + Mon, 21 Jul 2025 21:21:47 GMT + + + https://mintlify.com/docs + + <![CDATA[June 2025]]> + https://mintlify.com/docs/changelog#june-2025 + https://mintlify.com/docs/changelog#june-2025 + Mon, 23 Jun 2025 16:54:22 GMT + + ```