Changelogs

Publique atualizações de produto na sua documentação com um feed RSS ao qual os usuários podem se inscrever

Crie um changelog para sua documentação adicionando Componentes de atualização a uma página.

Confira o changelog da Mintlify como exemplo: você pode incluir links, imagens, texto e demonstrações dos seus novos recursos em cada atualização.

Configurando seu changelog

1. Crie uma página para o seu changelog

   1. Crie uma nova página na sua documentação, como changelog.mdx ou updates.mdx.
   2. Adicione a página de changelog ao esquema de navegação no seu docs.json.
2. Adicione componentes Update ao seu changelog

   Adicione um Update para cada entrada do changelog.

   Inclua informações relevantes, como lançamentos de funcionalidades, correções de bugs ou outros anúncios.

Example changelog.mdx

---
title: "Changelog"
description: "Atualizações de produto e anúncios"
---
<Update label="Março de 2025" description="v0.0.10">
  Adicionamos um novo sabor Wintergreen.

  Lançamos uma nova versão do sabor Spearmint, agora com 10% mais menta.
</Update>

<Update label="Fevereiro de 2025" description="v0.0.09">
  Lançamos uma nova versão do sabor Spearmint.
</Update>

Personalizando seu changelog

Controle como as pessoas navegam pelo seu changelog e se mantêm atualizadas sobre as informações do seu produto.

Sumário

Cada propriedade label de um Update cria automaticamente uma entrada no sumário da barra lateral direita. Essa é a navegação padrão do seu changelog.

Filtros por tags

Adicione tags aos componentes Update para substituir o índice por filtros de tags. Os usuários podem filtrar o changelog selecionando uma ou mais tags:

Tag filters example

<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>

O índice e os filtros do changelog ficam ocultos ao usar os modos de página custom, center ou wide. Saiba mais sobre os modos de página.

Changelogs assináveis

O uso dos componentes Update cria um feed RSS assinável na URL da sua página com /rss.xml ao final. Por exemplo, mintlify.com/docs/changelog/rss.xml.

As entradas são adicionadas ao feed RSS quando novos componentes Update são publicados e quando novos cabeçalhos são adicionados dentro de tags <Update> existentes.

Os cabeçalhos de nível superior dos componentes Update são usados como títulos das entradas do feed RSS, e as entradas apontam para as âncoras desses cabeçalhos na sua documentação.

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>

Feeds RSS podem ser integrados ao Slack, e-mail ou outras ferramentas de assinatura para notificar usuários sobre mudanças no produto. Algumas opções incluem:

• Slack
• E-mail via Zapier
• Bots do Discord como o Readybot ou o RSS Feeds to Discord Bot

Para tornar o feed RSS mais fácil de descobrir, você pode exibir um botão de ícone de RSS que aponte para o feed no topo da página. Adicione rss: true ao frontmatter da página:

---
rss: true
---