Updates
The Update component for building changelog pages with dated entries and tags.
The <Update> component renders changelog entries with a sticky meta column — title, description, and version tags on the left, content on the right. Stack multiple updates on one page to build a full changelog.
Usage
Improvements
Props
| Prop | Type | Description |
|---|---|---|
title | string | Entry heading, e.g. a date or release name (required). Also becomes the entry's anchor id. |
description | string | Muted secondary line under the title |
tags | string or string[] | Version tags rendered as pills: tags="v2.1, v2.2" or tags={["v2.1", "v2.2"]} |
Deep links
Each update gets an anchor derived from its title — title="June 2026" is linkable as #june-2026. Dots become hyphens, so a version reads as one: title="v2.4.0" is #v2-4-0.
Deprecated: label
label is the older name of title. It still renders, but it's
deprecated and will stop working at the end of
its notice window. The build log warns with the file and line, and
stx migrate renames it:
Don't set both on one tag — stx migrate leaves such a tag for you to fix by hand.
Changelog pages on doc engine v2
On a doc engine v2 site, a page whose path is changelog
(or ends in /changelog, such as product/changelog) is laid out as a
changelog feed:
<Update> entries run down a date railtags — show only
the entries with that tag, and an RSS feed link points at the page's
Atom feed. The chips appear only when at least one entry has
tags<Update> entries yet shows an empty stateEvery entry's anchor comes from its title, as above; a title used more than
once gets -2, -3, … on the later entries, so #june-2026-2 is the second
"June 2026". An entry with no title takes its anchor from description. The
link icon beside each title puts the anchor in the address bar and copies the
URL.
Atom feed
A v2 changelog page also publishes an Atom feed of its first 50 entries — the
newest, when you list them newest first — at
<changelog path>/feed.xml — /changelog/feed.xml, or
/product/changelog/feed.xml for product/changelog. Each feed entry links
to the entry's anchor on the page, carries its tags as categories, and holds
its content as plain HTML.
The entry's date is read from its description, or else its title, in forms
like these:
| Written | Read as |
|---|---|
9 November 2026, 9th Nov 2026 | 9 November 2026 |
2026-10-21 | 21 October 2026 |
Nov 3, 2026, November 3rd 2026 | 3 November 2026 |
November 2026, 2026-11 | 1 November 2026 |
The date can sit inside other text (Released 9 November 2026). An entry
with no readable date takes the newest date in the feed, and a feed with no
dates at all takes the build time.
Feed readers find it from any page: every page of the site carries
<link rel="alternate" type="application/atom+xml"> pointing at the feed, and
robots.txt lists it as an extra Sitemap: after sitemap.xml. v1 sites
have no feed.
See Doc engine v2.
On smaller screens the meta column stacks above the content and the timeline border is hidden.