Plandalf

Update

Use update blocks for release notes, docs changelog entries, and filterable component changes.

Updates are timeline entries. When a page has multiple update tags, the right rail can expose tag filters.

Basic example

API docs upgraded

2026-06-20

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

<Update label="API docs upgraded" description="2026-06-20" tags={["api", "docs"]} icon="badge">
  API pages now use endpoint blocks with request and response examples in the right rail.
</Update>

Timeline entries

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

Component pages expanded

2026-06-20

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

API examples moved right

2026-06-20

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

<Update label="Component pages expanded" description="2026-06-20" tags={["components", "docs"]} icon="layout-grid">
  The component catalog now links to individual pages for the Mintlify-style MDX family.
</Update>

<Update label="API examples moved right" description="2026-06-20" tags={["api", "examples"]} icon="braces">
  Endpoint pages can keep request and response examples in the right example rail.
</Update>

RSS metadata

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

SDK checkout docs

2026-06-20

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

<Update
  label="SDK checkout docs"
  description="2026-06-20"
  tags={["sdk", "checkout"]}
  icon="code"
  rss={{
    title: "SDK checkout documentation expanded",
    description: "The SDK checkout reference now includes endpoint-aware request and response examples."
  }}
>
  The public docs now show the SDK checkout calls alongside copyable request and response examples.
</Update>

Authoring rules

Update usage

Use for dated changerelease note

Use an update when the date or change history matters to the reader.

Use a banner foractive notice

Use a banner when the notice affects the whole current page or a migration is still active.

Keep labels stableanchors

The label creates the default anchor. Add an explicit id if the label may change.

Tag consistentlyright rail filters

Reuse tag names such as api, sdk, components, and docs so filters stay predictable.

Props

labelstringrequired

Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique.

tagsstring[]

Tags for the update. Shown as filters in the right side panel when the page exposes update filters.

descriptionstring

Description of the update. Appears below the label and tags.

rssobject

Optional RSS title and description metadata.

titlestring

Custom title for the RSS feed entry.

descriptionstring

Custom description for the RSS feed entry.

Plandalf extensions

datestring

Alternate date value. description takes precedence when both are present.

idstring

Stable anchor ID for the update.

iconstringdefault: badge

Icon shown beside the update label.

iconTypestring

Icon style metadata for icon libraries that support variants.

class | classNamestring

Optional utility classes for local spacing or sizing.

Badge Use compact status labels.
Banner Use page-level notices.
Updates overview See update rail behavior.

Feature detail