Changelog
Publish product updates, fixes, and release notes from structured MDX files.
What Changelogs Do
Relevate can turn a folder of release notes into a polished changelog section with index pages, entry pages, search records, RSS feeds, and localized routes.
Use changelogs when you want product updates to feel like part of the docs instead of a separate blog or manually maintained page.
Changelog entries are ordinary MDX files with release metadata in frontmatter.
Enable A Changelog
Add a changelog collection to docs.json and place the changelog tab in navigation.
{
"changelog": {
"path": "/changelog"
},
"navigation": {
"tabs": [
{
"id": "docs",
"label": "Docs",
"content": ["getting-started"]
},
{
"id": "changelog",
"label": "Changelog",
"icon": "clock",
"content": ["changelog"]
}
]
}
}
Then create a changelog folder:
Entry Frontmatter
Every changelog entry needs frontmatter. The body below the frontmatter can use normal Markdown and Relevate components.
---
title: Team workspaces
description: Invite teammates, organize docs, and manage access from one workspace.
type: new
date: 2026-04-08
label: April 2026
tags: ["Teams", "Permissions"]
rss:
title: Team workspaces
description: Team workspaces, invitations, and access settings for RSS subscribers.
---
Team workspaces make it easier to manage documentation with the rest of your company.
## What's included
- Invite teammates by email.
- Group docs by workspace.
- Keep billing and access settings in one place.
The entry title shown on the changelog page and entry page.
Optional short summary used for previews and metadata.
The release category shown as the entry badge.
The release date. Relevate sorts entries newest first.
Optional status badge for entries that need extra context.
Optional grouping label, often a version such as v0.6.0.
Optional tags displayed with the entry. When a changelog page has multiple tags, Relevate shows tag filters and keeps the selected filters in the page URL as ?tags=....
Optional RSS-only metadata. Use this when the entry body contains components, screenshots, demos, or extra detail that should be summarized differently for subscribers.
File Names And Slugs
Relevate derives the public entry slug from the file name.
- Date-prefixedchangelog/2026-04-08-team-workspaces.mdxThanks. We will use this to improve the snippet.
- Year folderchangelog/2026/04-08-team-workspaces.mdxThanks. We will use this to improve the snippet.
- Manual slugchangelog/custom-launch.mdxThanks. We will use this to improve the snippet.
The first two examples become /changelog/team-workspaces. The manual slug becomes /changelog/custom-launch.
Use unique slugs inside each changelog collection. Duplicate slugs fail the build so readers never land on the wrong release note.
Changelog Index
changelog/index.mdx is optional. Use it to override the collection title, description, or add intro content above the generated entries.
---
title: Product Updates
description: New features, fixes, and release notes.
---
Follow this page for the latest Relevate changes.
Multiple Changelogs
Use changelogs when you need more than one release stream.
{
"changelogs": {
"api": {
"path": "/api/changelog"
},
"platform": {
"path": "/platform/changelog"
}
}
}
Each collection uses the same folder and frontmatter model. Add each root to navigation where readers expect it.
Localization
Changelogs follow the same locale folder rules as pages.
Keep translated entry slugs aligned when you want language switching to feel predictable.
Generated Output
When a changelog is configured, Relevate generates:
A changelog index route such as
/changelogEntry routes such as
/changelog/team-workspacesPaginated changelog pages when needed
RSS feeds at
/rss.xmlfor the default changelog and/{collection}/rss.xmlfor named collectionsTag filters for entries that include tags
Search and assistant-ready records for visible changelog content
If an update changes behavior, link from the changelog entry back to the relevant guide or reference page. Changelogs are best when they explain what changed and where to act next.