Skip to content

docs: expand availability tags from 6 to 17 values#4324

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773764762-expand-availability-tags
Open

docs: expand availability tags from 6 to 17 values#4324
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773764762-expand-availability-tags

Conversation

@devin-ai-integration
Copy link
Contributor

Summary

Updates documentation to reflect the expanded set of availability tags (from 6 to 17). This is the docs-side companion to fern-api/fern-platform#8684 (FDR SDK/backend) and fern-api/fern#13631 (CLI).

Files changed:

  • navigation.mdx — updated inline availability options list
  • frontmatter.mdx — updated valid values description in <ParamField>
  • snippets/availability.mdx — updated shared snippet used across API reference docs
  • changelog/2026-03-17.mdx — new changelog entry documenting the 11 added tags

New tags: release-candidate, public-beta, private-beta, limited-availability, canary-release, preview, alpha, experimental, internal, sunset, retired.

Review & Testing Checklist for Human

  • Cross-repo deployment order: These docs advertise tags that only work once fern-platform#8684 and fern#13631 are deployed. Verify merge/deploy sequencing so users don't see documented tags that fail validation.
  • Readability of inline lists: The availability options are now 17 items in a single comma-separated inline list. Consider whether a table, bullet list, or <Accordion> would be more scannable — the current format is quite dense.
  • Verify the preview deployment renders the availability section on the navigation page and frontmatter page correctly.

Notes

  • The version-availability.mdx snippet (for version-level deprecated/ga/stable/beta) was intentionally not changed — version availability is a separate, smaller enum.
  • The changelog entry uses a plant-themed example (Plant API) per repo conventions.

Link to Devin session: https://app.devin.ai/sessions/b659d40b9db14dc7a30abbb3785613b9

Co-Authored-By: rishabh <rishabh@buildwithfern.com>
@devin-ai-integration devin-ai-integration bot requested a review from devalog as a code owner March 17, 2026 16:28
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring


## 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated


## 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.


## 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'also' instead of 'In addition'.


## 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated

@@ -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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.

@github-actions
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants