From 1473fe71e59899dad05b42a68f359f9c438a81a6 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 29 Sep 2025 14:30:33 -0400 Subject: [PATCH 1/2] document changelog tags --- .../docs/pages/customization/frontmatter.mdx | 13 ++++++- .../docs/pages/navigation/changelogs.mdx | 34 ++++++++----------- fern/snippets/changelog-example.mdx | 23 +++++++++++++ 3 files changed, 50 insertions(+), 20 deletions(-) create mode 100644 fern/snippets/changelog-example.mdx diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index 604b36676..a0f93ad54 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -253,4 +253,15 @@ Currently, relative paths are _not_ supported for this field. [Use the metadata field in the `docs.yml` file](/learn/docs/configuration/what-is-docs-yml#seo-metadata-configuration). - \ No newline at end of file + + +## Changelog tags + + + For [changelog pages](/docs/customization/changelogs) only. Tags allow users to filter changelog entries by specific categories. Define tags as an array of strings in the frontmatter. + + For non-changelog pages, [use `keywords`](/docs/configuration/page-level-settings#document-properties). + + + + diff --git a/fern/products/docs/pages/navigation/changelogs.mdx b/fern/products/docs/pages/navigation/changelogs.mdx index 33048f77c..60ea65bb9 100644 --- a/fern/products/docs/pages/navigation/changelogs.mdx +++ b/fern/products/docs/pages/navigation/changelogs.mdx @@ -3,7 +3,7 @@ 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. +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. -```mdx -## Summary - -In the latest release, we've added endpoints to create a new Plant. + -### What's new? +### Entry date -New endpoints: +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: -- `POST /plant` add a new plant to inventory. +- MM-DD-YYYY (e.g., 10-06-2024) +- MM-DD-YY (e.g., 10-06-24) +- YYYY-MM-DD (e.g., 2024-04-21) -New object schemas: +### Tags -- `CreatePlantRequest` +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: - Have questions? Reach out to your local botanist. + +```mdx +--- +tags: ["plants-api", "breaking-change", "inventory-management"] +--- ``` -### 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) +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 diff --git a/fern/snippets/changelog-example.mdx b/fern/snippets/changelog-example.mdx new file mode 100644 index 000000000..d3ca37b45 --- /dev/null +++ b/fern/snippets/changelog-example.mdx @@ -0,0 +1,23 @@ + +```mdx +--- +tags: ["plants-api", "breaking-change", "inventory-management"] +--- + +## 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. +``` + \ No newline at end of file From b5ee6f355fee00ab539753066d2902994ff9e027 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 29 Sep 2025 16:35:37 -0400 Subject: [PATCH 2/2] remove reference to keywords --- fern/products/docs/pages/customization/frontmatter.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index a0f93ad54..0e0c1535b 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -259,8 +259,6 @@ Currently, relative paths are _not_ supported for this field. For [changelog pages](/docs/customization/changelogs) only. Tags allow users to filter changelog entries by specific categories. Define tags as an array of strings in the frontmatter. - - For non-changelog pages, [use `keywords`](/docs/configuration/page-level-settings#document-properties).