Registros de cambios

Publica actualizaciones de producto en tu documentación con un canal RSS al que los usuarios pueden suscribirse

Crea un registro de cambios para tu documentación añadiendo componentes de actualización a una página.

Consulta el registro de cambios de Mintlify como ejemplo: en cada actualización puedes incluir enlaces, imágenes, texto y demostraciones de tus nuevas funciones.

​

Configurar tu registro de cambios

1. Crea una página para tu registro de cambios

   1. Crea una nueva página en tu documentación, como changelog.mdx o updates.mdx.
   2. Agrega la página del registro de cambios a tu esquema de navegación en docs.json.
2. Agrega componentes Update a tu registro de cambios

   Agrega un Update por cada entrada del registro de cambios.

   Incluye información relevante como lanzamientos de funciones, correcciones de errores u otros anuncios.

Ejemplo de changelog.mdx

---
title: "Registro de cambios"
description: "Actualizaciones y anuncios del producto"
---
<Update label="Marzo de 2025" description="v0.0.10">
  Se añadió un nuevo sabor a Wintergreen.

  Se lanzó una nueva versión del sabor Spearmint, ahora con un 10% más de menta.
</Update>

<Update label="Febrero de 2025" description="v0.0.09">
  Se lanzó una nueva versión del sabor Spearmint.
</Update>

​

Personalizar el registro de cambios

Controla cómo las personas navegan por tu registro de cambios y se mantienen al día con la información de tu producto.

​

Tabla de contenidos

Cada propiedad label de un Update crea automáticamente una entrada en la tabla de contenidos de la barra lateral derecha. Esta es la navegación predeterminada de tu registro de cambios.

​

Filtros por etiquetas

Agrega tags a tus componentes Update para sustituir la tabla de contenidos por filtros de etiquetas. Los usuarios pueden filtrar el registro de cambios seleccionando una o más etiquetas:

Ejemplo de ajuste de filtros por etiquetas

<Update label="Marzo de 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  Se añadió un nuevo sabor Wintergreen.

  Se publicó una nueva versión del sabor Spearmint, ahora con un 10% más de menta.
</Update>

<Update label="Febrero de 2025" description="v0.0.09" tags={["Spearmint"]}>
  Se publicó una nueva versión del sabor Spearmint.
</Update>

<Update label="Enero de 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  Se retiró el sabor Peppermint.

  Se publicó una nueva versión del sabor Spearmint.
</Update>

La tabla de contenido y los filtros del registro de cambios se ocultan cuando se usan los modos de página custom, center o wide. Más información sobre los modos de página.

​

Registros de cambios con suscripción

Usar componentes Update crea un feed RSS al que te puedes suscribir en la URL de tu página con /rss.xml agregado. Por ejemplo, mintlify.com/docs/changelog/rss.xml.

Las entradas se agregan al feed RSS cuando se publican nuevos componentes Update y cuando se agregan nuevos encabezados dentro de etiquetas <Update> existentes.

Los encabezados de nivel superior de los componentes Update se usan como títulos de las entradas del feed RSS y estas enlazan a sus anclas de encabezado en tu documentación.

Ejemplo de fuente RSS

<?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[Actualizaciones de producto]]></title>
    <description><![CDATA[Novedades y mejoras]]></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[Junio de 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>

Los feeds RSS pueden integrarse con Slack, correo electrónico u otras herramientas de suscripción para notificar a los usuarios sobre cambios en el producto. Algunas opciones incluyen:

• Slack
• Email mediante Zapier
• Bots de Discord como Readybot o RSS Feeds to Discord Bot

Para que el feed RSS sea fácil de descubrir, puedes mostrar un botón con el ícono de RSS que enlace al feed en la parte superior de la página. Agrega rss: true al frontmatter de la página:

---
rss: true
---