# Update
Use update blocks for release notes, docs changelog entries, and filterable component changes.
Source: /docs/components/update
Last modified: 2026-06-20
Updates are timeline entries. When a page has multiple update tags, the right rail can expose tag filters.

## Basic example


  API pages now use endpoint blocks with request and response examples in the right rail.


```mdx title="update-example.mdx"

  API pages now use endpoint blocks with request and response examples in the right rail.

```

## Timeline entries

Stack multiple updates when a page needs a compact changelog. Keep each entry tied to a real docs or product change.


  The component catalog now links to individual pages for the Mintlify-style MDX family.


  Endpoint pages can keep request and response examples in the right example rail.


  Linked cards and tiles require icons and avoid nested card surfaces.


```mdx title="update-timeline.mdx"

  The component catalog now links to individual pages for the Mintlify-style MDX family.


  Endpoint pages can keep request and response examples in the right example rail.

```

## RSS metadata

Use `rss` when an update should feed a changelog or release feed with cleaner summary text than the rendered MDX body.


  The public docs now show the SDK checkout calls alongside copyable request and response examples.


```mdx title="update-rss.mdx"

  The public docs now show the SDK checkout calls alongside copyable request and response examples.

```

## Authoring rules


### Update usage


- `Use for dated change` (release note):
    Use an update when the date or change history matters to the reader.


- `Use a banner for` (active notice):
    Use a banner when the notice affects the whole current page or a migration is still active.


- `Keep labels stable` (anchors):
    The label creates the default anchor. Add an explicit `id` if the label may change.


- `Tag consistently` (right rail filters):
    Reuse tag names such as `api`, `sdk`, `components`, and `docs` so filters stay predictable.


## Props


- `label` (string; required):
  Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique.


- `tags` (string[]):
  Tags for the update. Shown as filters in the right side panel when the page exposes update filters.


- `description` (string):
  Description of the update. Appears below the label and tags.


- `rss` (object):
  Optional RSS title and description metadata.


> **properties**
>


- `title` (string):
      Custom title for the RSS feed entry.


- `description` (string):
      Custom description for the RSS feed entry.


## Plandalf extensions


- `date` (string):
  Alternate date value. `description` takes precedence when both are present.


- `id` (string):
  Stable anchor ID for the update.


- `icon` (string; default: badge):
  Icon shown beside the update label.


- `iconType` (string):
  Icon style metadata for icon libraries that support variants.


- `class | className` (string):
  Optional utility classes for local spacing or sizing.


## Related


  - [Badge](/docs/components/badge): Use compact status labels.
  - [Banner](/docs/components/banner): Use page-level notices.
  - [Updates overview](/docs/components/updates): See update rail behavior.