Changelog
The changelog keeps a public, versioned record of what changed in your product or docs. Write entries yourself or let AI draft release notes from pages you updated recently.
Open the changelog
Open a collection and click Updates in the left sidebar. The changelog is available for documentation and API collections, not for blogs.
Write an entry by hand
- In Add Change Log, choose Manual.
- Pick an Update Type:
- Patch, Minor or Major: DocStar works out the next version number from your latest entry (for example, v1.2.3 becomes v1.2.4 for a patch).
- Manual: type your own version, such as
v2.0.0-beta.
- Enter a title.
- Open Tags and pick one: Bug Fixes, Deprecation, Improvements or New Feature.
- Write the release notes in the editor. Headings, lists, links and other formatting all work.
- Click Add Change Log.
Version, title and content are required. New entries are saved but not public yet.
Generate an entry with AI
- In Add Change Log, choose AI Generate.
- Under Recent Pages, tick the pages the release notes should cover, or click Select All.
- Click Generate.
DocStar drafts the notes in the background. This can take up to 24 hours. The draft appears in your list when it's ready, so you can review it before publishing.
Generate entries automatically
Turn on Subscribe to changelogs to have DocStar draft a changelog entry whenever pages in the collection are updated. Drafts still need your review before they go public.
Publish, edit and unpublish
Each entry in the list has these actions:
- Publish makes the entry public.
- Unpublish hides it again.
- Edit opens it in the form. Save with Update Change Log.
- Delete removes it.
If you edit an entry that is already published, readers keep seeing the old version until you publish again.
Statuses and filters
| Filter | What it shows |
|---|---|
| Published | Live entries readers can see |
| Drafted | Published entries with edits that aren't live yet |
| Unpublished | Entries that aren't public |
| All | Everything |
Use Search Change Logs... to find entries by title, content or tag.
The public changelog page
Published entries appear on your docs site at /changelog, for example https://docs.example.com/changelog. Click View Public Changelog to open it and copy the link. Readers can also link to a single entry.
If your docs use a custom domain, an RSS feed is also available at /changelog.xml so readers can subscribe in a feed reader.
Tips
- Keep titles short and specific: "Faster search results" is better than "Improvements".
- Use one tag per entry so readers can scan quickly.
- Review AI drafts for accuracy and tone before publishing.
- Click How it works → API on the changelog page to manage entries through the API.