Changelogs

Veröffentlichen Sie Produktupdates in Ihren Docs mit einem abonnierbaren RSS-Feed

Erstellen Sie ein Changelog für Ihre Docs, indem Sie einer Seite Update-Komponenten hinzufügen.

Sehen Sie sich das Mintlify-Changelog als Beispiel an: In jedem Update können Sie Links, Bilder, Text und Demos Ihrer neuen Funktionen einbinden.

Einrichten Ihres Changelogs

1. Erstellen Sie eine Seite für Ihr Changelog

   1. Erstellen Sie eine neue Seite in Ihren Docs, z. B. changelog.mdx oder updates.mdx.
   2. Fügen Sie die Changelog-Seite Ihrem Navigationsschema in der docs.json hinzu.
2. Fügen Sie Ihrem Changelog Update-Komponenten hinzu

   Fügen Sie für jeden Changelog-Eintrag ein Update hinzu.

   Geben Sie relevante Informationen wie Feature-Releases, Bugfixes oder andere Ankündigungen an.

Beispiel changelog.mdx

---
title: "Changelog"
description: "Produktupdates und Ankündigungen"
---
<Update label="März 2025" description="v0.0.10">
  Eine neue Wintergreen-Geschmacksrichtung hinzugefügt.

  Eine neue Version der Spearmint-Geschmacksrichtung veröffentlicht, jetzt mit 10 % mehr Minze.
</Update>

<Update label="Februar 2025" description="v0.0.09">
  Eine neue Version der Spearmint-Geschmacksrichtung veröffentlicht.
</Update>

Anpassen Ihres Changelogs

Steuern Sie, wie Nutzer durch Ihr Changelog navigieren und bei Ihren Produktinformationen auf dem Laufenden bleiben.

Inhaltsverzeichnis

Jede label-Eigenschaft eines Update erzeugt automatisch einen Eintrag im Inhaltsverzeichnis der rechten Seitenleiste. Dies ist die Standardnavigation für dein Changelog.

Tag-Filter

Fügen Sie tags zu Ihren Update-Komponenten hinzu, um das Inhaltsverzeichnis durch Tag-Filter zu ersetzen. Nutzer können das Changelog filtern, indem sie ein oder mehrere Tags auswählen:

Tag filters example

<Update label="März 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  Eine neue Wintergreen-Sorte hinzugefügt.

  Eine neue Version der Spearmint-Sorte veröffentlicht, jetzt mit 10 % mehr Minze.
</Update>

<Update label="Februar 2025" description="v0.0.09" tags={["Spearmint"]}>
  Eine neue Version der Spearmint-Sorte veröffentlicht.
</Update>

<Update label="Januar 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  Die Peppermint-Sorte als veraltet markiert.

  Eine neue Version der Spearmint-Sorte veröffentlicht.
</Update>

Das Inhaltsverzeichnis und die Changelog-Filter werden ausgeblendet, wenn die Seitenmodi custom, center oder wide verwendet werden. Erfahren Sie mehr über Seitenmodi.

Abonnierbare Changelogs

Die Verwendung von Update-Komponenten erzeugt einen abonnierbaren RSS-Feed an der Seiten-URL mit angehängtem /rss.xml. Zum Beispiel: mintlify.com/docs/changelog/rss.xml.

Einträge werden dem RSS-Feed hinzugefügt, wenn neue Update-Komponenten veröffentlicht werden und wenn neue Überschriften innerhalb bestehender <Update>-Tags hinzugefügt werden.

Die Überschriften der obersten Ebene von Update-Komponenten werden als Titel der RSS-Feed-Einträge verwendet, und die Einträge verlinken auf ihre Überschriftsanker in Ihren Docs.

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.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 lassen sich mit Slack, E-Mail oder anderen Abo-Tools integrieren, um Nutzer über Produktänderungen zu informieren. Einige Optionen sind:

• Slack
• E-Mail via Zapier
• Discord-Bots wie Readybot oder RSS Feeds to Discord Bot

Damit der RSS-Feed auffindbar ist, können Sie oben auf der Seite ein RSS-Symbol anzeigen, das zum Feed verlinkt. Fügen Sie rss: true zum Frontmatter der Seite hinzu:

---
rss: true
---