/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components Updates

Updates

The Update component for building changelog pages with dated entries and tags.

4 min read

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

mdx
<Update title="June 2026" description="Week of June 22" tags="v2.1.185, v2.1.193">
## New features
- Custom domains now provision in under a minute
- Added Go SDK support for the search API
## Fixes
- Fixed sidebar collapse state not persisting across pages
</Update>
<Update title="May 2026" description="Week of May 18" tags="v2.1.170">
## Improvements
- Build pipeline is 2x faster for incremental changes
</Update>

June 2026

Week of June 22
v2.1.185v2.1.193

New features

•
Custom domains now provision in under a minute
•
Added Go SDK support for the search API

Fixes

•
Fixed sidebar collapse state not persisting across pages

May 2026

Week of May 18
v2.1.170

Improvements

•
Build pipeline is 2x faster for incremental changes

Props

PropTypeDescription
titlestringEntry heading, e.g. a date or release name (required). Also becomes the entry's anchor id.
descriptionstringMuted secondary line under the title
tagsstring or string[]Version tags rendered as pills: tags="v2.1, v2.2" or tags={["v2.1", "v2.2"]}

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:

mdx
{/* Deprecated */}
<Update label="June 2026">…</Update>
{/* Use */}
<Update title="June 2026">…</Update>

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:

•
the <Update> entries run down a date rail
•
above them, filter chips — All plus every tag used in tags — 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
•
the right-hand table of contents is titled Recent releases and lists the first 10 entries' titles, without the Ask, Copy and Edit actions
•
after 10 entries the page shows Showing 10 of N updates · Load older updates, and each click shows 10 more. The older entries are already in the page and hidden before it first paints, so nothing moves; with JavaScript off, every entry shows. A filter chip shows every matching entry, and a link to an older entry's anchor opens the list down to it
•
a changelog page with no <Update> entries yet shows an empty state

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

WrittenRead as
9 November 2026, 9th Nov 20269 November 2026
2026-10-2121 October 2026
Nov 3, 2026, November 3rd 20263 November 2026
November 2026, 2026-111 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.

Note

On smaller screens the meta column stacks above the content and the timeline border is hidden.

Was this page helpful? Yes No
Previous
Next
Product
Resources
Company
© 2026 SyntextBuilt with Syntext