Setting Up Your Changelog Page

Show your users what has changed in each release by creating a dedicated changelog page on your site. This guide walks you through creating the page, configuring the display, and customizing it for different products.

Time to read: 5 minutes

Creating the Changelog Page

Step 1: Create a New WordPress Page

Go to Pages > Add New in your WordPress admin
Enter a title like “Changelog” or “What’s New”
Add the changelog shortcode (see below)
Publish the page

Step 2: Add the Shortcode

Paste this shortcode into your page content:

[roadmap_changelog]

This displays all changelog entries across all products, grouped by version number and sorted by release date (newest first).

Step 3: Preview Your Page

Click Preview or visit the published page. Your changelog page displays entries grouped by version with change type badges, product labels, and release dates.

You should see your changelog entries displayed with:

Version numbers as section headers (e.g., “Version 2.5.0”)
Release dates below each version
Change items listed with colored type badges
Type labels like “New Feature,” “Bug Fix,” or “Enhancement”

What Users See on the Frontend

Each changelog entry appears as a card with the following elements:

Element	Description
Version number	Large header showing the release version
Release date	Formatted date below the version
Type badges	Color-coded labels for each change type
Change descriptions	The actual text of each change

Change Type Badges

Each change item shows a colored badge based on its type:

Badge	Meaning
New Feature	Something brand new was added
Enhancement	An existing feature was improved
Bug Fix	A problem was corrected
Security	A security issue was addressed
Update	A general update or dependency change
Deprecated	A feature marked for future removal
Breaking Change	A change that may require user action

Badge colors are configurable through the changelog_type taxonomy in your WordPress admin. Go to Roadmap > Changelog Types to customize colors for each type.

Filtering by Product

If you manage multiple products with the Pro addon, show changelogs for a specific product:

[roadmap_changelog product="mobile-app"]

Replace mobile-app with your product’s slug. Find the slug under Roadmap > Products.

Per-Product Changelog Pages

Create separate pages for each product:

Create a page titled “Mobile App Changelog”
Add [roadmap_changelog product="mobile-app"]
Repeat for each product

Link these pages from your product documentation or navigation menu so users find the right changelog quickly.

Shortcode Parameters

Customize the changelog display with these parameters:

Parameter	Type	Default	Description
`product`	string	(all)	Filter by product slug
`version`	string	(all)	Show a single version only
`id`	integer	(none)	Show a specific changelog entry by post ID

Examples

Show only the latest release for a product:

[roadmap_changelog product="web-app" version="3.0.0"]

Embed a specific entry in a blog post announcing the release:

[roadmap_changelog id="456"]

Linking Changelog to Roadmap Items

When a roadmap item reaches “Completed” status and ships in a release, reference it in the changelog entry description. This helps users connect the dots between what they voted for and what shipped.

For example, a changelog entry description might read:

Added dark mode support across all pages. Originally requested on the roadmap and received 87 votes.

Page Layout Tips

Dedicated Changelog Page

For a standalone changelog page:

Use a full-width page template if your theme supports it
Add a brief introduction above the shortcode explaining what the page shows
Link to it from your site footer or help menu

Example page structure:

Page Title: Changelog

Welcome to our changelog. Here you'll find details on every release,
including new features, improvements, and bug fixes.

[roadmap_changelog]

Changelog Widget in Sidebar

Some site owners add a compact changelog to a sidebar or widget area. Use the version parameter to show only the latest release:

[roadmap_changelog version="2.5.0"]

Update the version parameter after each release, or use the id parameter to pin a specific entry.

SaaS Product Example

A typical SaaS changelog page includes:

Page title — “What’s New” or “Release Notes”
Product filter — If multiple products, note which product the page covers
Shortcode — [roadmap_changelog product="saas-app"]
Footer link — “View our roadmap” linking to the roadmap page

Troubleshooting

Changelog page shows nothing

Verify you have published changelog entries under Roadmap > Changelog
Check that entries have a version number and at least one change item
If using the product parameter, confirm the slug matches a product that has entries

Entries appear in the wrong order

Entries sort by release date (newest first)
Verify the <em>changelog</em>release_date meta field is set on each entry
Entries without a date appear at the end

Type badges not showing colors

Go to Roadmap > Changelog Types in the admin
Verify each type has a changelog<em>type</em>color term meta value set
Colors should be valid hex values (e.g., #22c55e)

Next Steps

Changelog Management — Assign entries to products, use the REST API
Multi-Product Management — Set up products for per-product changelogs
Pro Settings — Configure changelog display options

← Changelog Management | Webhooks & Integrations →