Changelog

Pubblica aggiornamenti di prodotto nella tua documentazione con un feed RSS a cui ci si può iscrivere

Crea un changelog per la tua documentazione aggiungendo la Update component a una pagina.

Dai un’occhiata al changelog di Mintlify come esempio: in ogni aggiornamento puoi includere link, immagini, testo e demo delle nuove funzionalità.

Configurazione del changelog

1. Crea una pagina per il changelog

   1. Crea una nuova pagina nella documentazione, ad esempio changelog.mdx o updates.mdx.
   2. Aggiungi la pagina del changelog allo schema di navigazione in docs.json.
2. Aggiungi i componenti Update al changelog

   Aggiungi un Update per ogni voce del changelog.

   Includi informazioni rilevanti come nuove funzionalità, correzioni di bug o altri annunci.

Example changelog.mdx

---
title: "Changelog"
description: "Aggiornamenti del prodotto e annunci"
---
<Update label="Marzo 2025" description="v0.0.10">
  Aggiunto un nuovo gusto Wintergreen.

  Rilasciata una nuova versione del gusto Spearmint, ora con il 10% in più di menta.
</Update>

<Update label="Febbraio 2025" description="v0.0.09">
  Rilasciata una nuova versione del gusto Spearmint.
</Update>

Personalizzare il changelog

Gestisci come gli utenti navigano il tuo changelog e restano aggiornati sulle informazioni sul prodotto.

Indice

Ogni proprietà label di un Update crea automaticamente una voce nell’indice della barra laterale destra. Questa è la navigazione predefinita per il tuo changelog.

Filtri per tag

Aggiungi tags ai componenti Update per sostituire il sommario con filtri per tag. Gli utenti possono filtrare il changelog selezionando uno o più tag:

Tag filters example

<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  Aggiunto un nuovo gusto Wintergreen.

  Rilasciata una nuova versione del gusto Spearmint, ora con il 10% di menta in più.
</Update>

<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
  Rilasciata una nuova versione del gusto Spearmint.
</Update>

<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  Deprecato il gusto Peppermint.

  Rilasciata una nuova versione del gusto Spearmint.
</Update>

Il sommario e i filtri del changelog sono nascosti quando si utilizzano le modalità di pagina custom, center o wide. Scopri di più sulle modalità di pagina.

Changelog sottoscrivibili

L’uso dei componenti Update crea un feed RSS sottoscrivibile all’URL della pagina con l’aggiunta di /rss.xml. Ad esempio, mintlify.com/docs/changelog/rss.xml.

Le voci vengono aggiunte al feed RSS quando vengono pubblicati nuovi componenti Update e quando vengono aggiunti nuovi titoli all’interno di tag <Update> esistenti.

I titoli di primo livello dei componenti Update vengono utilizzati come titoli delle voci del feed RSS e le voci rimandano agli anchor dei relativi titoli nella documentazione.

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[Aggiornamenti del prodotto]]></title>
    <description><![CDATA[Nuovi aggiornamenti e miglioramenti]]></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[Giugno 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>

I feed RSS possono integrarsi con Slack, email o altri strumenti di sottoscrizione per notificare agli utenti le modifiche al prodotto. Alcune opzioni includono:

• Slack
• Email via Zapier
• Bot di Discord come Readybot o RSS Feeds to Discord Bot

Per rendere il feed RSS facilmente individuabile, puoi mostrare un’icona RSS che rimanda al feed nella parte superiore della pagina. Aggiungi rss: true al frontmatter della pagina:

---
rss: true
---