From 10897d86c48ef6e1d29011e0c220d1437ec25a6c Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 16:27:09 +0000 Subject: [PATCH] docs: expand availability tags from 6 to 17 values and add changelog Co-Authored-By: rishabh --- .../docs/pages/changelog/2026-03-17.mdx | 31 +++++++++++++++++++ .../docs/pages/customization/frontmatter.mdx | 2 +- .../docs/pages/navigation/navigation.mdx | 2 +- fern/snippets/availability.mdx | 4 +-- 4 files changed, 35 insertions(+), 4 deletions(-) create mode 100644 fern/products/docs/pages/changelog/2026-03-17.mdx diff --git a/fern/products/docs/pages/changelog/2026-03-17.mdx b/fern/products/docs/pages/changelog/2026-03-17.mdx new file mode 100644 index 000000000..40c5fb906 --- /dev/null +++ b/fern/products/docs/pages/changelog/2026-03-17.mdx @@ -0,0 +1,31 @@ +--- +tags: ["navigation", "configuration", "docs.yml"] +--- + +## Expanded availability tags + +You can now use 17 availability tags for pages, sections, folders, and API reference endpoints. In addition to the original 6 values (`stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, `beta`), the following are now supported: + +- `release-candidate` +- `public-beta` +- `private-beta` +- `limited-availability` +- `canary-release` +- `preview` +- `alpha` +- `experimental` +- `internal` +- `sunset` +- `retired` + +```yaml docs.yml {3, 7} +navigation: + - section: Plant API + availability: generally-available + contents: + - page: Getting started + path: ./pages/getting-started.mdx + availability: preview +``` + + diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index fc69aae96..f476e4269 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -335,7 +335,7 @@ Currently, relative paths are _not_ supported for this field. ## Availability - Displays an availability badge on the page. When set in frontmatter, it overrides any [availability defined in the navigation](/learn/docs/configuration/navigation#availability) (`docs.yml`). Valid values are: `stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, or `beta`. + Displays an availability badge on the page. When set in frontmatter, it overrides any [availability defined in the navigation](/learn/docs/configuration/navigation#availability) (`docs.yml`). Valid values are: `stable`, `generally-available`, `release-candidate`, `public-beta`, `beta`, `private-beta`, `limited-availability`, `canary-release`, `preview`, `pre-release`, `alpha`, `experimental`, `internal`, `in-development`, `sunset`, `deprecated`, or `retired`. diff --git a/fern/products/docs/pages/navigation/navigation.mdx b/fern/products/docs/pages/navigation/navigation.mdx index 988422dc3..b498e8506 100644 --- a/fern/products/docs/pages/navigation/navigation.mdx +++ b/fern/products/docs/pages/navigation/navigation.mdx @@ -186,7 +186,7 @@ navigation: ## Availability -Set availability badges on pages, sections, or folders. Options are: `stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, or `beta`. +Set availability badges on pages, sections, or folders. Options are: `stable`, `generally-available`, `release-candidate`, `public-beta`, `beta`, `private-beta`, `limited-availability`, `canary-release`, `preview`, `pre-release`, `alpha`, `experimental`, `internal`, `in-development`, `sunset`, `deprecated`, or `retired`. Pages inherit availability from their parent section or folder unless overridden by: - A per-page `availability` setting in `docs.yml` (shown below) diff --git a/fern/snippets/availability.mdx b/fern/snippets/availability.mdx index 86d143909..4604960d9 100644 --- a/fern/snippets/availability.mdx +++ b/fern/snippets/availability.mdx @@ -1,4 +1,4 @@ -You can set the availability for the entire API reference or for specific sections in your `docs.yml` configuration. Options are: `stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, or `beta`. +You can set the availability for the entire API reference or for specific sections in your `docs.yml` configuration. Options are: `stable`, `generally-available`, `release-candidate`, `public-beta`, `beta`, `private-beta`, `limited-availability`, `canary-release`, `preview`, `pre-release`, `alpha`, `experimental`, `internal`, `in-development`, `sunset`, `deprecated`, or `retired`. When you set the availability of a section, all of the endpoints in that section are automatically marked with that availability unless explicitly set otherwise. @@ -12,4 +12,4 @@ navigation: icon: flower contents: # endpoints here -``` \ No newline at end of file +```