From 447205c967fa4362b44596f73025a1c9cc6cee4a Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Mon, 10 Nov 2025 17:43:26 +0000 Subject: [PATCH 1/4] Clarify custom frontmatter fields are not added to HTML head - Fix og:sitename to og:site_name in frontmatter example - Add note to SEO metadata page that custom fields aren't supported - Add note to frontmatter page SEO section with same clarification - Link to custom JavaScript docs for analytics tracking workaround Co-Authored-By: Devin Logan --- fern/products/docs/pages/customization/frontmatter.mdx | 4 +++- fern/products/docs/pages/seo/metadata.mdx | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index cbe513256..c1ab81416 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -16,7 +16,7 @@ subtitle: Set titles, add meta descriptions, and more slug: frontmatter description: Use frontmatter to set the page title, subtitle, slug, meta description, its OpenGraph image, and a URL to suggest edits. keywords: frontmatter, seo, customization, metadata -og:sitename: Your Company Inc. +og:site_name: Your Company Inc. og:title: SEO Metadata Title --- ``` @@ -253,6 +253,8 @@ Currently, relative paths are _not_ supported for this field. [Use the metadata field in the `docs.yml` file](/learn/docs/configuration/site-level-settings#seo-metadata-configuration). +Only the documented SEO fields below are converted into HTML meta tags. Custom frontmatter fields are not added to the page head. For custom analytics tracking, see [custom JavaScript](/learn/docs/customization/custom-css-js). + ## Changelog tags diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 4f91e9a26..bbacfc819 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -61,4 +61,8 @@ Set default SEO metadata for your entire documentation site in [`docs.yml`](/doc Configure SEO metadata in your page's [frontmatter](/docs/configuration/page-level-settings) to control how individual pages appear in search results and social media shares. These settings override site-wide settings. + +Only the documented SEO fields below are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). + + From 28d07071c2e3d46f93c1b66524d7b82fd9f411b8 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Mon, 10 Nov 2025 18:00:12 +0000 Subject: [PATCH 2/4] Refactor duplicate notes into reusable snippet - Create seo-custom-metadata-note.mdx snippet - Replace inline notes in metadata.mdx and frontmatter.mdx with snippet reference - Ensures consistent messaging across both pages Co-Authored-By: Devin Logan --- fern/products/docs/pages/customization/frontmatter.mdx | 2 +- fern/products/docs/pages/seo/metadata.mdx | 4 +--- fern/snippets/seo-custom-metadata-note.mdx | 3 +++ 3 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 fern/snippets/seo-custom-metadata-note.mdx diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index c1ab81416..23f1f8dc6 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -253,7 +253,7 @@ Currently, relative paths are _not_ supported for this field. [Use the metadata field in the `docs.yml` file](/learn/docs/configuration/site-level-settings#seo-metadata-configuration). -Only the documented SEO fields below are converted into HTML meta tags. Custom frontmatter fields are not added to the page head. For custom analytics tracking, see [custom JavaScript](/learn/docs/customization/custom-css-js). + diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index bbacfc819..44bd666e0 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -61,8 +61,6 @@ Set default SEO metadata for your entire documentation site in [`docs.yml`](/doc Configure SEO metadata in your page's [frontmatter](/docs/configuration/page-level-settings) to control how individual pages appear in search results and social media shares. These settings override site-wide settings. - -Only the documented SEO fields below are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). - + diff --git a/fern/snippets/seo-custom-metadata-note.mdx b/fern/snippets/seo-custom-metadata-note.mdx new file mode 100644 index 000000000..9bd9afde1 --- /dev/null +++ b/fern/snippets/seo-custom-metadata-note.mdx @@ -0,0 +1,3 @@ + +Only the documented SEO fields are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). + From 4e9f30b2875094fd3829073f5251a2181381f3d8 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Mon, 10 Nov 2025 18:02:07 +0000 Subject: [PATCH 3/4] Fix Vale warning: use contraction 'aren't' instead of 'are not' Co-Authored-By: Devin Logan --- fern/snippets/seo-custom-metadata-note.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/snippets/seo-custom-metadata-note.mdx b/fern/snippets/seo-custom-metadata-note.mdx index 9bd9afde1..85e8a79f8 100644 --- a/fern/snippets/seo-custom-metadata-note.mdx +++ b/fern/snippets/seo-custom-metadata-note.mdx @@ -1,3 +1,3 @@ -Only the documented SEO fields are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). +Only the documented SEO fields are recognized. Custom frontmatter fields aren't added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). From 171b315088782f208cf0d0b846ae2e4549ccb6dc Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 10 Nov 2025 14:28:22 -0500 Subject: [PATCH 4/4] clarify snippet --- fern/products/docs/pages/customization/frontmatter.mdx | 2 -- fern/products/docs/pages/seo/metadata.mdx | 2 -- fern/snippets/seo-custom-metadata-note.mdx | 3 --- fern/snippets/seo-metadata-page.mdx | 4 ++++ 4 files changed, 4 insertions(+), 7 deletions(-) delete mode 100644 fern/snippets/seo-custom-metadata-note.mdx diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index 23f1f8dc6..75d7ca792 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -253,8 +253,6 @@ Currently, relative paths are _not_ supported for this field. [Use the metadata field in the `docs.yml` file](/learn/docs/configuration/site-level-settings#seo-metadata-configuration). - - ## Changelog tags diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 44bd666e0..4f91e9a26 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -61,6 +61,4 @@ Set default SEO metadata for your entire documentation site in [`docs.yml`](/doc Configure SEO metadata in your page's [frontmatter](/docs/configuration/page-level-settings) to control how individual pages appear in search results and social media shares. These settings override site-wide settings. - - diff --git a/fern/snippets/seo-custom-metadata-note.mdx b/fern/snippets/seo-custom-metadata-note.mdx deleted file mode 100644 index 9bd9afde1..000000000 --- a/fern/snippets/seo-custom-metadata-note.mdx +++ /dev/null @@ -1,3 +0,0 @@ - -Only the documented SEO fields are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js). - diff --git a/fern/snippets/seo-metadata-page.mdx b/fern/snippets/seo-metadata-page.mdx index efd950a1a..079e11730 100644 --- a/fern/snippets/seo-metadata-page.mdx +++ b/fern/snippets/seo-metadata-page.mdx @@ -1,3 +1,7 @@ + +Only the documented SEO fields are added to the HTML `` as meta tags. Custom frontmatter fields won't automatically appear in your page metadata. To add custom metadata, use [custom JavaScript](/learn/docs/customization/custom-css-js#custom-javascript). + + ```mdx ---