Skip to content

Remove banner and add deprecation callout to Fern Definition pages #5526

Open
fern-api[bot] wants to merge 4 commits into
mainfrom
fern/remove-banner-add-callout
Open

Remove banner and add deprecation callout to Fern Definition pages #5526
fern-api[bot] wants to merge 4 commits into
mainfrom
fern/remove-banner-add-callout

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 15, 2026

Summary

Removes the announcement banner from the API Definitions product (which was showing on all pages including OpenAPI, AsyncAPI, etc.) and replaces it with a targeted callout snippet on each Fern Definition page only.

Changes

  • Removed the announcement field from the API Definitions product in fern/docs.yml
  • Created a reusable snippet at fern/products/api-def/snippets/ferndef-deprecation.mdx with a <Note> callout explaining Fern Definition is no longer recommended for new customers and that feature requests are not being accepted
  • Added the snippet to all 22 Fern Definition pages

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 15, 2026 22:49
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 15, 2026

Requested by: devin
Slack thread: View conversation

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.Contractions] Use 'isn't' instead of 'is not'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.We] Try to avoid using first-person plural like 'We'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.Contractions] Use 'we're' instead of 'We are'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers. We are not actively developing new features or accepting feature requests for this format. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.We] Try to avoid using first-person plural like 'we'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.Contractions] Use 'isn't' instead of 'is not'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.We] Try to avoid using first-person plural like 'we'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.Contractions] Use 'we're' instead of 'we are'.

@@ -0,0 +1,3 @@
<Note title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers and we are not accepting feature requests for this format. It remains supported for existing users. If you're starting a new project, we recommend using [OpenAPI](/learn/api-definitions/openapi/overview) instead.
Copy link
Copy Markdown
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.We] Try to avoid using first-person plural like 'we'.

@@ -0,0 +1,3 @@
<Warning title="Fern Definition is no longer recommended">
Fern Definition is not recommended for new customers and Fern isn't accepting feature requests for this format. It remains supported for existing users.
Copy link
Copy Markdown
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.Contractions] Use 'isn't' instead of 'is not'.

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.

1 participant