Overview
The Changelog System helps teams track and publish product updates for collections and pages. It supports both manual changelog creation and AI-generated release notes based on recent page updates.
Users can:
Create and manage changelog entries
Publish updates publicly
Track versions and release history
Generate changelogs automatically using AI
Creating a Changelog
Manual Creation
Users can manually create changelog entries by adding:
Version number
Title
Content
Update type
Tags
The editor supports rich text formatting for structured release notes.
AI-Generated Changelog
The system can automatically generate changelog drafts from recently updated pages.
How it works
Detects recently updated pages
Generates release notes automatically
Creates a draft changelog entry
Only the latest updated pages are considered for generation.
Update Types
Each changelog can be categorized as:
Major
Minor
Patch
manual (if user wants)
This helps users understand the impact of updates quickly.
Tags
Tags help organize updates.
Common tags include:
Bug Fixes
Improvements
New Feature
Deprecation
Changelog Status
Each changelog entry supports different states:
Status | Description |
|---|---|
Draft | Internal editing state |
Unpublished | Saved but hidden |
Published | Publicly visible |
Search & Filters
Users can:
Search by title, content, version, or tags
Filter by published, draft, or unpublished entries
This makes it easier to manage large changelog histories.
Public Changelog Page
Each collection can have a public changelog page that users can share externally.
Example:
https://yourdomain.com/changelog
Auto-Generation Subscription
Collections can enable automatic changelog generation.
When enabled:
Page updates are monitored automatically
AI-generated changelog drafts are created
Teams can review drafts before publishing
User Workflow
Typical Flow
Open the changelog section
Create manually or generate with AI
Review content
Save as draft or publish
Share public changelog page
Key Benefits
Maintains clear version history
Reduces manual documentation work
Helps communicate updates to users
Provides searchable release tracking
Supports automated release note generation