Keep a changelog

Keep a record of how your project has changed by writing changelog entries that users can sort by tag. The changelog will automatically populate with the files contained within the changelog folder.

Configure your changelog

Add a changelog folder to your project. This folder must be named changelog exactly — Fern won’t recognize it under any other name.

1
fern/
2
├─ fern.config.json
3
├─ docs.yml
4
├─ changelog/
5
    ├─ 07-08-24.md
6
    └─ 08-21-24.mdx

Then, reference it in your docs.yml. You can place the changelog as its own tab or as a section within your navigation.

1
tabs:
2
  guides:
3
    display-name: Guides
4
    icon: light book-open
5
  api:
6
    display-name: API Reference
7
    icon: light code
8
  changelog:
9
    display-name: Changelog
10
    icon: light clock
11
    changelog: ./changelog
12
13
navigation:
14
  - tab: guides
15
    layout:
16
      ...
17
  - tab: changelog

Write a changelog entry

Create a new changelog entry by writing a Markdown file. You can use .md or .mdx files. The benefit of using .mdx is that you can leverage Fern’s built-in component library within an entry.

1
---
2
tags: ["plants-api", "breaking-change", "inventory-management"]
3
---
4
5
## Summary
6
7
In the latest release, we've added endpoints to create a new Plant.
8
9
### What's new?
10
11
New endpoints:
12
13
- `POST /plant` add a new plant to inventory.
14
15
New object schemas:
16
17
- `CreatePlantRequest`
18
19
<Note> Have questions? Reach out to your local botanist. </Note>

Entry date

Changelog entries are automatically sorted chronologically by the date specific in the file name. Specify the date of your entry using one of the following formats:

• MM-DD-YYYY (e.g., 10-06-2024)
• MM-DD-YY (e.g., 10-06-24)
• YYYY-MM-DD (e.g., 2024-04-21)

Tags

Add tags to changelog entries to help users filter and find relevant updates. Tags are defined in the frontmatter of your changelog entry as an array of strings:

1
---
2
tags: ["plants-api", "breaking-change", "inventory-management"]
3
---

When you have multiple changelog entries, users can filter the changelog page by selecting specific tags. Use specific, descriptive tags that your users would naturally search for. Consider tagging by feature type, product area, release stage, affected platform, or user impact.

Linking to an entry

Each changelog entry has a unique URL you can direct users to. For example, https://elevenlabs.io/docs/changelog/2025/3/31

Overview page

Add an overview.mdx file to your changelog folder to include a high-level overview at the top of your changelog. This is useful for summarizing major themes, linking to external release notes, or giving users context before diving into specific entries. If present, it will automatically appear above the list of changelog entries.

RSS feed

Changelogs automatically come with an RSS feed so users can subscribe to updates. Navigate to the RSS feed by appending .rss to the changelog path. For example, https://elevenlabs.io/docs/changelog.rss