Changelog

Publiez des mises à jour produit dans votre documentation avec un flux RSS auquel s’abonner

Créez un changelog pour votre documentation en ajoutant des composants Update à une page.

Consultez le changelog de Mintlify comme exemple : vous pouvez inclure des liens, des images, du texte et des démos de vos nouvelles fonctionnalités dans chaque mise à jour.

Configuration de votre journal des modifications

1. Créer une page pour votre journal des modifications

   1. Créez une nouvelle page dans votre documentation, par exemple changelog.mdx ou updates.mdx.
   2. Ajoutez la page de votre journal des modifications à votre navigation dans votre docs.json.
2. Ajouter des composants Update à votre journal des modifications

   Ajoutez un Update pour chaque entrée du journal des modifications.

   Incluez des informations pertinentes comme des sorties de fonctionnalités, des correctifs de bugs ou d’autres annonces.

Example changelog.mdx

---
title: "Journal des modifications"
description: "Mises à jour produit et annonces"
---
<Update label="Mars 2025" description="v0.0.10">
  Ajout d'une nouvelle saveur Wintergreen.

  Publication d'une nouvelle version de la saveur Spearmint, désormais avec 10 % de menthe en plus.
</Update>

<Update label="Février 2025" description="v0.0.09">
  Publication d'une nouvelle version de la saveur Spearmint.
</Update>

Personnaliser votre journal des modifications

Maîtrisez la façon dont les utilisateurs naviguent dans votre journal des modifications et restent informés des nouveautés de votre produit.

Table des matières

Chaque propriété label d’une Update crée automatiquement une entrée dans la table des matières de la barre latérale droite. C’est la navigation par défaut de votre journal des modifications.

Filtres de tags

Ajoutez des tags à vos composants Update pour remplacer la table des matières par des filtres de tags. Les utilisateurs peuvent filtrer le journal des modifications en sélectionnant un ou plusieurs tags :

Tag filters example

<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  Ajout d’un nouveau parfum Wintergreen.

  Publication d’une nouvelle version du parfum Spearmint, désormais avec 10 % de menthe en plus.
</Update>

<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
  Publication d’une nouvelle version du parfum Spearmint.
</Update>

<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  Abandon du parfum Peppermint.

  Publication d’une nouvelle version du parfum Spearmint.
</Update>

La table des matières et les filtres du journal des modifications sont masqués lorsque vous utilisez les modes de page custom, center ou wide. En savoir plus sur les modes de page.

Fils de changements abonnables

L’utilisation des composants Update crée un flux RSS abonnable à l’URL de votre page avec /rss.xml ajouté. Par exemple, mintlify.com/docs/changelog/rss.xml.

Des entrées sont ajoutées au flux RSS lorsque de nouveaux composants Update sont publiés et lorsque de nouveaux titres sont ajoutés à l’intérieur des balises <Update> existantes.

Les titres de niveau supérieur des composants Update sont utilisés comme titres des entrées du flux RSS, et les entrées renvoient vers leurs ancres de titre dans votre documentation.

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>

Les flux RSS peuvent s’intégrer à Slack, à l’e-mail ou à d’autres outils d’abonnement pour notifier les utilisateurs des changements produits. Quelques options :

• Slack
• E-mail via Zapier
• Des bots Discord comme Readybot ou RSS Feeds to Discord Bot

Pour rendre le flux RSS détectable, vous pouvez afficher une icône RSS en haut de la page qui pointe vers le flux. Ajoutez rss: true au frontmatter de la page :

---
rss: true
---