Changelogs

Create a changelog for your docs using our Changelogs native feature.

Check out our own changelog: Product Updates.

Creating a Changelog

To create a changelog:

• In the editor top navigation, open the scope picker and 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 .

Placing a Changelog in the Navigation

A changelog can sit inside a navigation group, alongside the documentation sections and API references it belongs with, rather than on its own in the top navigation bar.

Open Manage Changelogs, select the changelog, and pick a group next to Navigation group. Choose None to take it out again. A changelog can be in one group at a time.

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.

Creating Posts Programmatically

You can also create and list changelog posts through the API. This is useful for publishing release notes automatically from your CI/CD pipeline.

Editing in a Synced Repository

If your project uses GitHub Sync, your changelogs are mirrored to the repository under changelogs/, one folder per changelog and one file per post. You can write a release note there and review it through a pull request, and posts you write in the editor are committed back. See Changelogs for the file layout and frontmatter.

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 next to the changelog title.

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 next to the changelog title. Posts are exported in markdoc format.