What is a Changelog?
A changelog is a chronological record of notable changes to your product. Each entry documents what’s new, what’s improved, or what’s been fixed.Why Publish Changelogs?
- Close the Loop: Show users their feedback led to real changes
- Build Trust: Demonstrate consistent progress and transparency
- Reduce Support Load: Users find answers in changelog entries
- Increase Engagement: Keep users excited about your product evolution
Creating a Changelog Entry
Fill in the Details
Required Fields:
- Title: A clear, descriptive headline (3-200 characters)
Example: “Mobile App Launch”, “Dark Mode Support” - Description: Full details of the update (supports Markdown, up to 50,000 characters)
- Slug: Auto-generated from title, used in the URL
Example: “mobile-app-launch”
- Cover Image: Upload a hero image to make the entry visually appealing
- Labels: Add up to 3 labels (New, Improvement, Fix, Announcement)
- Link Feedback: Connect feedback items that led to this update
Changelog States
Every changelog entry has a status:Draft
Work in progress. Only visible to your team. Edit anytime.
Scheduled
Set to publish automatically at a future date and time.
Published
Live on your public changelog. Cannot be edited once published.
Scheduling Changelogs
Schedule entries to publish automatically at a specific date and time.How to Schedule
- Create or edit a changelog entry
- Set Status to “Scheduled”
- Select Publication Date & Time
- Click Save
What Happens When It Publishes
- Entry automatically moves to “Published” status
- Appears on your public changelog
- Notifications sent (if enabled)
Scheduled changelogs must have a future date. You cannot schedule for a past date.
Notifying Users
Keep your users in the loop by sending notifications when you publish changelogs.Notification Options
When creating or editing a changelog, you can choose:Notify Subscribers
Enabled by default. Sends email notifications to users who subscribed to your updates.
Silent Publish
Disable notifications for minor updates or corrections.
Who Gets Notified?
- Users who subscribed to changelog updates via your public portal
- Users who voted or commented on linked feedback items (coming soon)
Using Labels
Labels help categorize and visually distinguish different types of updates.Default Labels
| Label | Color | Use Case |
|---|---|---|
| New | Green #10b981 | Brand new features |
| Improvement | Blue #3b82f6 | Enhancements to existing features |
| Fix | Red #ef4444 | Bug fixes |
| Announcement | Purple #8b5cf6 | Company news, partnerships, etc. |
Adding Labels
- While creating/editing a changelog
- Click Add Label
- Select up to 3 labels
- Labels appear as colorful badges on the changelog card
You can customize label names and colors in Settings → Changelog Labels.
Linking Feedback
Connect changelog entries to the feedback items that inspired them.Why Link Feedback?
- Show Impact: Users see their feedback led to real changes
- Traceability: Track which features came from user requests
- Auto-updates: Linked feedback items show “Shipped in Changelog” badge
How to Link Feedback
- While creating/editing a changelog
- Scroll to Linked Feedback section
- Search for feedback items by title
- Select one or more items
- Click Add
What Users See
When feedback is linked to a changelog:- A ”✓ Shipped” badge appears on the feedback item
- A link to the changelog entry is displayed
- Users get notified (if they voted/commented on it)
Pinning Important Updates
Pin critical announcements to the top of your changelog.When to Pin
- Major product launches
- Breaking changes
- Critical security updates
- Company announcements
How to Pin
- Open the changelog entry
- Click the Pin icon in the top right
- Pinned entries stay at the top regardless of publication date
Only published changelogs can be pinned. You can pin multiple entries.
Public Changelog Page
Your changelog is automatically available at:What Users See
- All published entries in reverse chronological order (newest first)
- Pinned entries at the very top
- Labels for quick filtering
- Cover images if you added them
- Full descriptions with Markdown rendering
- Linked feedback items as clickable links
Customization Options
Control your public changelog appearance in Settings → General:- Enable/disable changelog page
- Customize page header text
- Set default sorting (newest/oldest first)
Best Practices
Publish Regularly
Consistent updates show active development. Aim for at least monthly changelogs.
Write for Users, Not Devs
Use plain language. Say “You can now…” instead of “Implemented feature X”.
Add Visuals
Cover images and GIFs make entries more engaging and shareable.
Link Related Feedback
Always connect changelogs to user requests to show you’re listening.