The Product Updates section gives your users a chronological feed of what's changed in your product — new features, fixes, improvements, and removals. Entries are grouped by month in the portal sidebar, making it easy for users to catch up on recent changes.
Go to Editor → Product Updates to manage releases.
The Product Updates page only appears on your portal if the Product Updates section is enabled. Check Editor → Sections if you don't see it on your portal.
Creating a release
Click New Release in the top-right corner. A form appears at the top of the page with three header fields and an entries list.
Version
A short identifier for the release. This is displayed as a badge (e.g., v1.4.0) next to the release title on the portal.
Use a consistent format across all releases — pick one and stick with it:
| Format | Example |
|---|---|
| Semantic versioning | 1.4.0, 2.0.0-beta |
| Date-based | 2026-06, 2026.06.05 |
| Sequential | 42, Release 12 |
Title
A short, user-facing name for the release. Visitors see this as the main heading on the portal.
Examples: Performance Improvements · New Dashboard & Bug Fixes · June Release
Date
Defaults to today. Change it to the date the release was actually shipped — this controls which month group the release appears under in the portal sidebar.
Adding entries
Each release contains one or more entries. Every entry has two parts: a type and a description.
Entry types
| Type | Use for |
|---|---|
| Added | New features or capabilities |
| Fixed | Bug fixes |
| Improved | Enhancements to existing features |
| Changed | Behaviour or UI changes (including breaking changes) |
| Removed | Features or options that have been removed |
On the portal, each type is shown as a coloured badge next to the entry text — green for Added, red for Fixed, blue for Improved, yellow for Changed, grey for Removed.
Writing entry descriptions
Each description is a single line of plain text. Write it from the user's perspective — what changed and why it matters to them.
Good examples:
Export reports as PDF from the Reports pageFixed an issue where the chatbot would show a blank response on slow connectionsInvite links now expire after 7 days instead of 30Removed the legacy CSV importer — use the new Data Import tool instead
Avoid:
- Internal jargon or ticket references (
Fixed BUG-4821) - Vague entries (
Various improvements and fixes) - Developer-facing notes that users don't need to know
Adding more entries
Click + Add entry below the list to add another line. Click the × button on any entry to remove it. A release must have at least one entry.
Saving the release
Click Create to save. The release immediately appears in the list and on your portal's Product Updates page.
Editing a release
Click Edit on any row. The same form opens pre-filled — update any field and click Update to save.
Deleting a release
Click Delete on any row and confirm. Deletion is permanent.
Best practices
Post one release per shipped version, not per change. Group everything that went out in a single deployment into one release. Posting a separate release for every individual change makes the changelog noisy and hard to scan.
Backdate when catching up. If you're adding past releases retrospectively, set the date to when they actually shipped. This keeps the month grouping accurate and gives users a truthful history.
Use the date the user feels the change, not when you merged the code. If you shipped on a Friday but users saw it on Monday after a maintenance window, use Monday.
Be consistent with your version format from day one. Switching from semantic versioning to date-based halfway through looks messy on the portal. Decide on a format and keep it.
Lead with what the user can now do. Entries like "You can now filter by date range" are more engaging than "Added date range filter". Lead with the outcome when it's a meaningful new capability.
Use Changed or Removed for anything that might break a user's workflow. These types stand out visually and signal that the user may need to adjust something. Don't bury breaking changes under Improved.
Keep the Product Updates section visible. If the section is disabled, users can't see any releases — even if you've been adding them. Toggle it on from Editor → Sections.
Last updated: June 6, 2026