From c3e7521acda095d117644c0bdad829b153a37555 Mon Sep 17 00:00:00 2001 From: fern-support Date: Thu, 26 Mar 2026 19:14:54 +0000 Subject: [PATCH 1/4] Clarify that hidden API endpoints are automatically noindexed Co-Authored-By: bot_apk --- .../pages/api-references/customize-api-ref.mdx | 2 +- fern/products/docs/pages/changelog/2026-03-26.mdx | 9 +++++++++ .../docs/pages/navigation/hiding-content.mdx | 15 +++++++++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 fern/products/docs/pages/changelog/2026-03-26.mdx diff --git a/fern/products/docs/pages/api-references/customize-api-ref.mdx b/fern/products/docs/pages/api-references/customize-api-ref.mdx index 12d1207c4..beebb93b1 100644 --- a/fern/products/docs/pages/api-references/customize-api-ref.mdx +++ b/fern/products/docs/pages/api-references/customize-api-ref.mdx @@ -256,7 +256,7 @@ To customize the display of an endpoint, you can add a `title`. You can also use ### Hiding endpoints -You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL. +You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so you don't need to set `noindex` separately. diff --git a/fern/products/docs/pages/changelog/2026-03-26.mdx b/fern/products/docs/pages/changelog/2026-03-26.mdx new file mode 100644 index 000000000..d2a3d2ddb --- /dev/null +++ b/fern/products/docs/pages/changelog/2026-03-26.mdx @@ -0,0 +1,9 @@ +--- +tags: ["api-reference", "seo"] +--- + +## Hidden API endpoints are automatically noindexed + +API endpoints set to `hidden: true` in `docs.yml` are now documented as automatically excluded from search engine indexing. You don't need to separately configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. + + diff --git a/fern/products/docs/pages/navigation/hiding-content.mdx b/fern/products/docs/pages/navigation/hiding-content.mdx index b70b3d807..b1cf02005 100644 --- a/fern/products/docs/pages/navigation/hiding-content.mdx +++ b/fern/products/docs/pages/navigation/hiding-content.mdx @@ -37,6 +37,21 @@ noindex: true This page is hidden from the sidebar and search engines, but you can access it by direct link. +## Hiding an API endpoint + +You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing — there's no need to separately set `noindex: true`. + +```yaml title="docs.yml" {6} +navigation: + - api: API Reference + layout: + - plants: + - endpoint: POST /plants/{plantId} + hidden: true +``` + +For full configuration details including examples for OpenAPI, Fern Definition, WebSocket, and GraphQL endpoints, see [Hiding endpoints](/learn/docs/api-references/customize-api-ref#hiding-endpoints). + ## Hiding a section or version You can also hide an entire section or version from the sidebar — for example, a legacy API version or a section of internal tooling docs. From 287e9d978550f4d37d28b4801e1edeca560a9341 Mon Sep 17 00:00:00 2001 From: fern-support Date: Thu, 26 Mar 2026 19:17:28 +0000 Subject: [PATCH 2/4] Address Vale style suggestions: remove adverbs and time-relative terms Co-Authored-By: bot_apk --- fern/products/docs/pages/api-references/customize-api-ref.mdx | 2 +- fern/products/docs/pages/changelog/2026-03-26.mdx | 2 +- fern/products/docs/pages/navigation/hiding-content.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/fern/products/docs/pages/api-references/customize-api-ref.mdx b/fern/products/docs/pages/api-references/customize-api-ref.mdx index beebb93b1..e1b07adaa 100644 --- a/fern/products/docs/pages/api-references/customize-api-ref.mdx +++ b/fern/products/docs/pages/api-references/customize-api-ref.mdx @@ -256,7 +256,7 @@ To customize the display of an endpoint, you can add a `title`. You can also use ### Hiding endpoints -You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so you don't need to set `noindex` separately. +You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so you don't need to set `noindex`. diff --git a/fern/products/docs/pages/changelog/2026-03-26.mdx b/fern/products/docs/pages/changelog/2026-03-26.mdx index d2a3d2ddb..540c12014 100644 --- a/fern/products/docs/pages/changelog/2026-03-26.mdx +++ b/fern/products/docs/pages/changelog/2026-03-26.mdx @@ -4,6 +4,6 @@ tags: ["api-reference", "seo"] ## Hidden API endpoints are automatically noindexed -API endpoints set to `hidden: true` in `docs.yml` are now documented as automatically excluded from search engine indexing. You don't need to separately configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. +API endpoints set to `hidden: true` in `docs.yml` are automatically excluded from search engine indexing. You don't need to configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. diff --git a/fern/products/docs/pages/navigation/hiding-content.mdx b/fern/products/docs/pages/navigation/hiding-content.mdx index b1cf02005..3ec655faf 100644 --- a/fern/products/docs/pages/navigation/hiding-content.mdx +++ b/fern/products/docs/pages/navigation/hiding-content.mdx @@ -39,7 +39,7 @@ noindex: true ## Hiding an API endpoint -You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing — there's no need to separately set `noindex: true`. +You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing — there's no need to set `noindex: true`. ```yaml title="docs.yml" {6} navigation: From 7ba0f6336f064f718ea736838e653b7283243c2c Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 27 Mar 2026 08:21:47 -0400 Subject: [PATCH 3/4] remove changelog entry and fix cross references --- .../api-references/customize-api-ref.mdx | 2 +- .../docs/pages/changelog/2026-03-26.mdx | 9 ------ .../docs/pages/navigation/hiding-content.mdx | 32 +++++++++---------- 3 files changed, 17 insertions(+), 26 deletions(-) delete mode 100644 fern/products/docs/pages/changelog/2026-03-26.mdx diff --git a/fern/products/docs/pages/api-references/customize-api-ref.mdx b/fern/products/docs/pages/api-references/customize-api-ref.mdx index e1b07adaa..47accd8d2 100644 --- a/fern/products/docs/pages/api-references/customize-api-ref.mdx +++ b/fern/products/docs/pages/api-references/customize-api-ref.mdx @@ -256,7 +256,7 @@ To customize the display of an endpoint, you can add a `title`. You can also use ### Hiding endpoints -You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so you don't need to set `noindex`. +You can hide an endpoint from the API Reference by setting `hidden` to `true`. The endpoint will still be accessible at its URL but is automatically excluded from search engine indexing (`noindex`), so [you don't need to set `noindex`](/learn/docs/customization/hiding-content#hiding-an-api-endpoint). diff --git a/fern/products/docs/pages/changelog/2026-03-26.mdx b/fern/products/docs/pages/changelog/2026-03-26.mdx deleted file mode 100644 index 540c12014..000000000 --- a/fern/products/docs/pages/changelog/2026-03-26.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -tags: ["api-reference", "seo"] ---- - -## Hidden API endpoints are automatically noindexed - -API endpoints set to `hidden: true` in `docs.yml` are automatically excluded from search engine indexing. You don't need to configure `noindex` for hidden endpoints — hiding an endpoint removes it from both the sidebar and search results. - - diff --git a/fern/products/docs/pages/navigation/hiding-content.mdx b/fern/products/docs/pages/navigation/hiding-content.mdx index 3ec655faf..a0d79c0f6 100644 --- a/fern/products/docs/pages/navigation/hiding-content.mdx +++ b/fern/products/docs/pages/navigation/hiding-content.mdx @@ -4,7 +4,7 @@ title: Hiding content in your site -Fern provides two settings for hiding content: `hidden: true` (set in `docs.yml`) removes pages, sections, or versions from the sidebar, and `noindex: true` (set in [page frontmatter](/learn/docs/configuration/page-level-settings#noindex)) removes pages from search engines and [llms.txt](/learn/docs/ai-features/llms-txt). +Fern provides two settings for hiding content: `hidden: true` (set in `docs.yml`) removes pages, sections, versions, and endpoints from the sidebar, and `noindex: true` (set in [page frontmatter](/learn/docs/configuration/page-level-settings#noindex)) removes pages from search engines and [llms.txt](/learn/docs/ai-features/llms-txt). ## Hiding a page @@ -37,21 +37,6 @@ noindex: true This page is hidden from the sidebar and search engines, but you can access it by direct link. -## Hiding an API endpoint - -You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing — there's no need to set `noindex: true`. - -```yaml title="docs.yml" {6} -navigation: - - api: API Reference - layout: - - plants: - - endpoint: POST /plants/{plantId} - hidden: true -``` - -For full configuration details including examples for OpenAPI, Fern Definition, WebSocket, and GraphQL endpoints, see [Hiding endpoints](/learn/docs/api-references/customize-api-ref#hiding-endpoints). - ## Hiding a section or version You can also hide an entire section or version from the sidebar — for example, a legacy API version or a section of internal tooling docs. @@ -94,3 +79,18 @@ versions: +## Hiding an API endpoint + +You can hide individual API endpoints from the sidebar by setting `hidden: true` in the endpoint's layout configuration in `docs.yml`. Hidden endpoints are automatically excluded from search engine indexing so there's no need to set `noindex: true`. + +```yaml title="docs.yml" {6} +navigation: + - api: API Reference + layout: + - plants: + - endpoint: POST /plants/{plantId} + hidden: true +``` + +For full configuration details including examples for OpenAPI, Fern Definition, WebSocket, and GraphQL endpoints, see [Hiding endpoints](/learn/docs/api-references/customize-api-reference-layout#hiding-endpoints). + From 4584b923eddda60f15dd75c56fc497eb25cf6f5e Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 27 Mar 2026 08:22:07 -0400 Subject: [PATCH 4/4] fix vale --- fern/products/docs/pages/api-references/customize-api-ref.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/customize-api-ref.mdx b/fern/products/docs/pages/api-references/customize-api-ref.mdx index 47accd8d2..574e6519a 100644 --- a/fern/products/docs/pages/api-references/customize-api-ref.mdx +++ b/fern/products/docs/pages/api-references/customize-api-ref.mdx @@ -530,6 +530,6 @@ The following properties can be set on the `- api` entry in your `docs.yml` navi - Only used when your project has [multiple APIs](/learn/docs/api-references/generate-api-ref#include-more-than-one-api-reference). The value must match the folder name containing the API definition. Do not set this property if you only have a single API, as it will cause errors. + Only used when your project has [multiple APIs](/learn/docs/api-references/generate-api-ref#include-more-than-one-api-reference). The value must match the folder name containing the API definition. Don't set this property if you only have a single API, as it will cause errors.