Changelogs
Create a changelog for your docs using our Changelogs native feature.
Check out our own changelog: Product Updates.
Changelogs operate independently of specific versions, in contrast to pages. When a changelog is included within a page, it can quickly become outdated as soon as you clone a version and commence work on a new one.
Creating a Changelog
To create a changelog:
- From the left sidebar, choose Changelogs
- Click "Create new changelog".
- Give it a title and click Create.
You can now change the path and description of the changelog from its settings
Adding a Post
To add a new post to the changelog, click on New Post. Each post has a label, a slug to be accessed from, and contents. The contents of a post are the same as documentation pages and can include any block.
RSS Feed
Changelogs can be subscribed to through an RSS feed. This enables users to remain up-to-date with all the new posts.
Importing Posts
Posts can be imported in markdoc format by clicking the import button
Importing posts only adds posts to the changelog. It does not remove any posts.
Exporting Changelog
All posts in a changelog can be exported by clicking the export button