Add guide to changelogs + subscribable RSS feeds

changelog.mdx

@@ -1,18 +1,24 @@
 ---
 title: "Product updates"
 description: "New updates and improvements"
-mode: "center"
+rss: true
 ---
 
-<Update label="June 2025">
+<Update label="June 2025" rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}>
   ## AI assistant updates
 
   - Improved accuracy through agentic RAG with tool calling
   - Provides navigable links to referenced pages so that users can go directly to the source of answers
   - Copy shortcut for code examples generated by assistant
   - "Ask AI" shortcut on code blocks in documentation to generate explanations from the assistant
 
   Learn more in the [assistant docs](/guides/assistant).
+
+  ## Subscribable changelogs
+  - Automatically generate an RSS feed from changelog pages
+  - Integrate RSS-enabled updates with Slack, email, and other tools
+
+  Learn more in our new [Changelog guide](/guides/changelogs)
 
 </Update>
 
@@ -95,7 +101,7 @@
   - Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
   - Show code examples even when in simple mode for API playground
   - Support "command \+ k" shortcut for search in web editor
   - Codeblocks within callouts expand to fill the width of the callout area
 </Update>
 
 <Update label="February 2025">
@@ -126,9 +132,9 @@
 
   Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).
 
   ## .md support for LLMs
 
   All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.
 
   ## More Themes
 
@@ -210,7 +216,7 @@
   <Frame>
     ![llms.txt support](/images/changelog/llms.jpg)
   </Frame>
   All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)
 
   ## Localization
 
@@ -282,7 +288,7 @@
   ## Dashboard Improvements
 
   - Added ability to change custom domain to be /docs directly through dashboard settings.
   - Consolidated the login and signup pages to decrease friction and confusion.
   - Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
   - Added login with Google OAuth
   - Added ability to add new deployment through dashboard settings.
@@ -296,7 +302,7 @@
   - Don't allow search engines to crawl user-auth protected pages.
   - Revalidate the cache when an org is deleted.
   - We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
   - Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.
   - Add in-line-style support for icons
   - Fixed the pop-in of custom CSS in docs.
   - Properly show in-line code styling in conjunction with links.
@@ -329,7 +335,7 @@
   <Frame>
     ![SEO Improvements](/images/changelog/seo-improvements.jpeg)
   </Frame>
   We've fixed  both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.
 
   ## Dashboard Improvements
 
@@ -363,7 +369,7 @@
 
   ## File Uploads in API Playground
 
   By default, API playground requests are proxied by Mintlify. Now you can use
   `disableProxy` to disable this behavior and support request types like file
   uploads.
 
@@ -396,7 +402,7 @@
   </Frame>
   For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
   answer your users' questions when and where they asked. You can add this
   AI-powered chatbot to any web page: your landing page, inside your product, or
   on your existing documentation pages.
 
   - [Read the blog announcement](https://mintlify.com/blog/widget)
@@ -431,7 +437,7 @@
 <Update label="May 2024">
   ## Okta SSO
 
   We now support sign-on via Okta SAML and OIDC.
 
   ## Mintlify REST API
 
@@ -454,7 +460,7 @@
 <Update label="March 2024">
   ## Mintlify MDX for VSCode
 
   Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
 </Update>
 
 <Update label="February 2024">
@@ -463,7 +469,7 @@
   - Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
   - Versioning with tabs fully supported
   - Wildcard redirects now supported
   - CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
 </Update>
 
 <Update label="January 2024">

components/update.mdx

@@ -1,70 +1,76 @@
 ---
 title: "Update"
 description: "Keep track of changes and updates"
-icon: 'list-collapse'
+icon: "list-collapse"
 ---
 
-The `Update` component is used to keep track of changes and updates.
+Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting.
 
-<Update label="2024-10-12" description="v0.1.1">
+<Update label="Example" description="v0.1.1">
+  ## Example update
+
+  You can add anything here, like a screenshot, a code snippet, or a list of changes.
+
   <Frame>
     <img
       className="block"
       src="https://mintlify-assets.b-cdn.net/hero-light.png"
+      alt=""
     />
   </Frame>
 
-  ## Changelog
-
-  You can add anything here, like a screenshot, a code snippet, or a list of changes.
-
-  #### Features
+  ### Features
   - Responsive design
-  - Sticky section for each changelog
+  - Anchor for each update
+  - Generated RSS feed entry for each update
 </Update>
 
-<Update label="2024-10-11" description="v0.1.0">
-  ### How to use 
-  ```mdx
-  <Update label="2024-10-12" description="v0.1.1">
-    This is how you use a changelog with a label 
-    and a description.
-  </Update>
-  <Update label="2024-10-11" description="v0.1.0">
-    This is how you use a changelog with a label 
-    and a description.
-  </Update>
-  ```
+## How to use
 
-  You can use multiple `Update` components to create changelogs.
+```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.
 </Update>
+```
 
-<Tip>
-  Each `label` creates an anchor and also shows up on the table of contents on the right.
-</Tip>
+Use multiple `Update` components to create [changelogs](/guides/changelogs).
 
 ## Props
 
 <ResponseField name="label" type="string" required>
-  The label give to the update, appears as sticky text to the left of the changelog.
+  Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique.
 </ResponseField>
 
 <ResponseField name="tags" type="string[]">
-  Tags for the changelog, will be shown as filters in the right side panel.
+  Tags for the update. Shown as filters in the right side panel.
 </ResponseField>
 
 <ResponseField name="description" type="string">
-  Description of the update, appears below the label and tag.
+  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>
+  ```
 
-<RequestExample>
-
-```mdx Update Example
-<Update label="2024-10-12" description="v0.1.1">
-  This is how you use a changelog with a label 
-  and a description.
-</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>
 ```
 
-</RequestExample>
+  Learn more about [subscribable changelogs](/guides/changelogs#subscribable-changelogs).
+</ResponseField>

docs.json

@@ -119,6 +119,7 @@
               "react-components",
               "settings/custom-scripts",
               "settings/seo",
+              "guides/changelogs",
               "guides/hidden-pages",
               "settings/broken-links",
               "guides/monorepo",
@@ -493,4 +494,4 @@
       "destination": "authentication-personalization/personalization-setup"
     }
   ]
-}
+}

guides/changelogs.mdx

@@ -0,0 +1,152 @@
+---
+title: "Changelogs"
+description: "Post product updates in your docs with a subscribable RSS feed"
+icon: "newspaper"
+---
+
+Create a changelog for your docs by adding [Update components](/components/update) to a page.
+
+Check out the [Mintlify changelog](/changelog) as an example: you can include links, images, text, and demos of your new features in each update.
+
+## Setting up your changelog
+
+<Steps>
+  <Step title="Create a page for your changelog">
+    1. Create a new page in your docs such as `changelog.mdx` or `updates.mdx`.
+    2. Add your changelog page to your navigation scheme in your `docs.json`.
+  </Step>
+  <Step title="Add Update components to your changelog">
+    Add an `Update` for each changelog entry.
+
+    Include relevant information like feature releases, bug fixes, or other announcements.
+  </Step>
+</Steps>
+
+```mdx Example changelog.mdx
+---
+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` property for an `Update` automatically creates an entry in the right sidebar's table of contents. This is the default navigation for your changelog.
+
+<Frame>
+  <img 
+    src="/images/changelog-toc-light.png" 
+    alt="Changelog with table of contents displayed in light mode." 
+    className="block dark:hidden" 
+  />
+  <img 
+    src="/images/changelog-toc-dark.png" 
+    alt="Changelog with table of contents displayed in dark mode." 
+    className="hidden dark:block" 
+  />
+</Frame>
+
+### 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:
+
+```mdx Tag filters example wrap
+<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>
+```
+
+<Frame>
+  <img 
+    src="/images/changelog-filters-light.png" 
+    alt="Changelog in light mode with the Peppermint tag filter selected." 
+    className="block dark:hidden" 
+  />
+  <img 
+    src="/images/changelog-filters-dark.png" 
+    alt="Changelog in dark mode with the Peppermint tag filter selected." 
+    className="hidden dark:block" 
+  />
+</Frame>
+
+<Tip>
+  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
+
+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 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>
+</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
+* 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:
+
+```mdx
+---
+rss: true
+---
+```
+
+<Frame>
+  <img 
+    src="/images/changelog-rss-button-light.png" 
+    alt="Changelog page in light mode with RSS feed button enabled." 
+    className="block dark:hidden" 
+  />
+  <img 
+    src="/images/changelog-rss-button-dark.png" 
+    alt="Changelog page in dark mode with RSS feed button enabled." 
+    className="hidden dark:block" 
+  />
+</Frame>