Skip to content
Closed
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions create/changelogs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Changelogs"
description: "Create product changelogs with RSS feed support for subscribers."

Check warning on line 3 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L3

Spell out 'RSS', if it's unfamiliar to the audience.
keywords: ["product updates", "release notes", "RSS"]
---

Expand Down Expand Up @@ -95,17 +95,47 @@
</Frame>

<Tip>
The table of contents and changelog filters are hidden when using `custom`, `center`, or `wide` page modes. Learn more about [page modes](/organize/pages#page-mode).

Check warning on line 98 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L98

In general, use active voice instead of passive voice ('are hidden').
</Tip>

### Subscribable changelogs

Use `Update` components to create 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 create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L103

Spell out 'RSS', if it's unfamiliar to the audience.

The RSS feed publishes entries when you add new `Update` components and when modify headings inside of existing `Update` components.

Check warning on line 105 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L105

Spell out 'RSS', if it's unfamiliar to the audience.

RSS feed entries contain pure Markdown only. Components, code, and HTML elements are excluded. Use the `rss` property to provide alternative text descriptions for RSS subscribers when your updates include content that is excluded.

Check warning on line 107 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L107

Spell out 'RSS', if it's unfamiliar to the audience.

Check warning on line 107 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L107

In general, use active voice instead of passive voice ('are excluded').

Check warning on line 107 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L107

Use 'that's' instead of 'that is'.

Check warning on line 107 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L107

In general, use active voice instead of passive voice ('is excluded').

#### Importing snippets with Update components

You can import [reusable snippets](/create/reusable-snippets) containing `Update` components into your changelog pages. Updates from imported snippets are automatically included in the RSS feed.

```mdx Example changelog.mdx with snippet import
---
title: "Changelog"
description: "Product updates and announcements"
rss: true
---

import LatestUpdates from "/snippets/latest-updates.mdx";

<LatestUpdates />

<Update label="February 2025" description="v0.0.09">
Released a new version of the Spearmint flavor.
</Update>
```

```mdx Example snippets/latest-updates.mdx
<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>
```

Both absolute paths (`/snippets/latest-updates.mdx`) and relative paths (`../snippets/latest-updates.mdx`) are supported for snippet imports.

Check warning on line 137 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L137

Use parentheses judiciously.

Check warning on line 137 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L137

In general, use active voice instead of passive voice ('are supported').

```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">
Expand All @@ -128,13 +158,13 @@
</rss>
```

RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include:

Check warning on line 161 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L161

Spell out 'RSS', if it's unfamiliar to the audience.

* [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:

Check warning on line 167 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L167

Spell out 'RSS', if it's unfamiliar to the audience.

```mdx
---
Expand Down