diff --git a/fern/docs.yml b/fern/docs.yml index f038fe9faed4..229175851b1b 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -270,6 +270,9 @@ navigation: - page: Reusable snippets icon: fa-regular fa-recycle path: ./pages/fern-docs/content/reusable-snippets.mdx + - page: Changelog + path: ./pages/docs/writing-content/changelog.mdx + icon: fa-regular fa-clock - section: API References contents: diff --git a/fern/pages/docs/writing-content/changelog-astronomer.png b/fern/pages/docs/writing-content/changelog-astronomer.png new file mode 100644 index 000000000000..8d55595cb129 Binary files /dev/null and b/fern/pages/docs/writing-content/changelog-astronomer.png differ diff --git a/fern/pages/docs/writing-content/changelog-humanloop.png b/fern/pages/docs/writing-content/changelog-humanloop.png new file mode 100644 index 000000000000..9eeffdddc98c Binary files /dev/null and b/fern/pages/docs/writing-content/changelog-humanloop.png differ diff --git a/fern/pages/docs/writing-content/changelog.mdx b/fern/pages/docs/writing-content/changelog.mdx new file mode 100644 index 000000000000..6f40c93d4c17 --- /dev/null +++ b/fern/pages/docs/writing-content/changelog.mdx @@ -0,0 +1,153 @@ +--- +title: Keep a Changelog +subtitle: 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. + + + + + +## Configure your Changelog + + + +Configure a changelog for your project by creating a changelog folder. + + +```yaml {4-6} +fern/ +├─ fern.config.json +├─ docs.yml +├─ changelog + ├─ 07-08-24.md + └─ 08-21-24.mdx +``` + + +Once you've configured your changelog, specify where it should appear within your docs in your `docs.yml`. + + +```yaml {8-11} +tabs: + guides: + display-name: Guides + icon: light book-open + api: + display-name: API Reference + icon: light code + changelog: + display-name: Changelog + icon: light clock + changelog: ../changelog +``` + + +[View an example](https://github.com/humanloop/humanloop-docs/blob/30ddedaf6d2779361e8ee1f373f722364e5dd71d/fern/versions/v5.yml#L10-L13) in GitHub of Humanloop's `docs.yml` which powers [their Changelog](https://humanloop.com/docs/changelog). + + + +Configure a changelog at the API-level by creating a changelog folder specific to an API. + + + +```yaml {6-8} +fern/ +├─ fern.config.json +├─ docs.yml +└─ openapi/ + ├─ openapi.yml + └─ changelog + ├─ 07-15-24.md + └─ 08-23-24.mdx +``` + + +```yaml {7-9} +fern/ +├─ fern.config.json +├─ docs.yml +└─ definition/ + ├─ api.yml + ├─ imdb.yml + └─ changelog + ├─ 07-15-24.md + └─ 08-23-24.mdx +``` + + +```yaml {8-10,14-17} +fern/ +├─ fern.config.json +├─ docs.yml +└─ user-api + └─ openapi/ + ├─ openapi.yml + ├─ openapi-overrides.yml + └─ changelog + ├─ 07-15-24.md + └─ 08-23-24.mdx +└─ admin-api + └─ openapi/ + ├─ openapi.yml + └─ changelog + ├─ 06-29-24.md + └─ 08-02-24.md + └─ 08-15-24.md +``` + + + +Changelogs contained within your API folder will automatically be displayed at the bottom of your API reference. You do not need to configure your changelog(s) within `docs.yml`. + +View an example of a changelog per API in [Astronomer's docs](https://www.astronomer.io/docs/api/iam-api-reference/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](../components/overview.mdx) within an entry. + + +```mdx +## Summary + +In the latest release, we've added endpoints to create a new Plant. + +### What's new? + +New endpoints: + +- `POST /plant` add a new plant to inventory. + +New object schemas: + +- `CreatePlantRequest` + + Have questions? Reach out to your local botanist. +``` + + +### 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` \ No newline at end of file