Changelog
The changelog lets you communicate product updates to your users in a structured, browsable format. Each entry represents a release or update and is published to a public page that your users can visit at any time.
Creating changelog entries
Section titled “Creating changelog entries”Each changelog entry includes the following fields:
- Title — A short headline describing the update (e.g., “Dark mode support” or “Bug fix: CSV export”).
- Slug — A URL-friendly identifier generated from the title. You can customize it if needed.
- Body — The full content of the entry. The editor is powered by Tiptap and supports rich text formatting and Markdown syntax, so you can include headings, lists, code blocks, images, and more.
Draft and published states
Section titled “Draft and published states”Changelog entries support two states:
- Draft — The entry is not visible to users. Use this to prepare updates before they are ready to share. A draft entry has no published date set.
- Published — The entry is live and visible on your public changelog. When you publish an entry, the published date is recorded automatically.
You can save entries as drafts and publish them later when the timing is right.
Public changelog
Section titled “Public changelog”Your public changelog is available at:
{slug}.trackelio.com/changelogReplace {slug} with your workspace slug. Users can visit this page to browse all published entries in reverse chronological order, with the most recent updates at the top.
Best practices
Section titled “Best practices”- Be specific — Instead of “various improvements”, describe what actually changed.
- Group related changes — If a release includes multiple changes, list them in a single entry.
- Publish consistently — Regular changelog updates show users that your product is actively maintained.
- Link to relevant feedback — When an update addresses user feedback, mention it so users know their input led to action.