Keep a Changelog

Record the notable changes to your project

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

Keep your users updated as your project evolves

Configure your 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 the built-in component library within an entry.

fern/openapi/changelog/2024-07-31.mdx
1## Summary
2
3In the latest release, we've added endpoints to create a new Plant.
4
5### What's new?
6
7New endpoints:
8
9- `POST /plant` add a new plant to inventory.
10
11New object schemas:
12
13- `CreatePlantRequest`
14
15<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)

Linking to an Entry

Each changelog entry has a unique URL you can direct users to. For example, https://humanloop.com/docs/v5/changelog/2024/8/16