From 5db38899230d29c77098ce35d1c5ad38f1fa7a7a Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 21 Oct 2025 02:01:43 +0000 Subject: [PATCH 1/3] docs: enhance SEO metadata documentation with best practices Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/pages/seo/metadata.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 5e84eedcc..1c7d88940 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -5,7 +5,19 @@ description: Configure SEO metadata at the page or site level. Optimize your documentation's search visibility and social media presence by configuring SEO metadata at the page or site level. Properly configured metadata helps search engines understand your content and creates compelling previews when your pages are shared on social platforms. -When configuring SEO metadata, ensure your titles and descriptions are unique, descriptive, and relevant to the page content. Keep descriptions between 150-160 characters for optimal display in search results. +## Best practices + +When configuring SEO metadata, follow these guidelines for optimal results: + +**Titles**: Keep titles between 50-60 characters. Make them unique, descriptive, and relevant to the page content. Include your brand name for consistency. + +**Descriptions**: Aim for 150-160 characters. Write compelling copy that encourages clicks while accurately describing the content. Avoid keyword stuffing. + +**Images**: Use high-quality images sized at 1200x630 pixels for optimal display across social platforms. Ensure images are relevant to the content and include your branding. + +**Consistency**: Use consistent branding across all metadata fields. Your `og:site_name`, `twitter:site`, and `twitter:handle` should align with your brand identity. + +**Testing**: Use tools like [Facebook's Sharing Debugger](https://developers.facebook.com/tools/debug/) and [Twitter's Card Validator](https://cards-dev.twitter.com/validator) to preview how your pages will appear when shared. ## Page metadata From df1d26b18f4083e236b992a6ead306b7f2e46bac Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 21 Oct 2025 02:05:24 +0000 Subject: [PATCH 2/3] docs: fix vale warning by spelling out SEO acronym and removing best practices section Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/pages/seo/metadata.mdx | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 1c7d88940..3cd19916f 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -3,21 +3,7 @@ title: Configure SEO metadata description: Configure SEO metadata at the page or site level. --- -Optimize your documentation's search visibility and social media presence by configuring SEO metadata at the page or site level. Properly configured metadata helps search engines understand your content and creates compelling previews when your pages are shared on social platforms. - -## Best practices - -When configuring SEO metadata, follow these guidelines for optimal results: - -**Titles**: Keep titles between 50-60 characters. Make them unique, descriptive, and relevant to the page content. Include your brand name for consistency. - -**Descriptions**: Aim for 150-160 characters. Write compelling copy that encourages clicks while accurately describing the content. Avoid keyword stuffing. - -**Images**: Use high-quality images sized at 1200x630 pixels for optimal display across social platforms. Ensure images are relevant to the content and include your branding. - -**Consistency**: Use consistent branding across all metadata fields. Your `og:site_name`, `twitter:site`, and `twitter:handle` should align with your brand identity. - -**Testing**: Use tools like [Facebook's Sharing Debugger](https://developers.facebook.com/tools/debug/) and [Twitter's Card Validator](https://cards-dev.twitter.com/validator) to preview how your pages will appear when shared. +Optimize your documentation's search visibility and social media presence by configuring Search Engine Optimization (SEO) metadata at the page or site level. Properly configured metadata helps search engines understand your content and creates compelling previews when your pages are shared on social platforms. Keep titles between 50-60 characters and descriptions between 150-160 characters for optimal display in search results and social shares. ## Page metadata From 662381617b0f5fd7dd8c74794a1cbacb355dd9b6 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 21 Oct 2025 11:55:24 -0400 Subject: [PATCH 3/3] condense repetitive paragraph --- fern/products/docs/pages/seo/metadata.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 3cd19916f..7641a7e7e 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -3,7 +3,7 @@ title: Configure SEO metadata description: Configure SEO metadata at the page or site level. --- -Optimize your documentation's search visibility and social media presence by configuring Search Engine Optimization (SEO) metadata at the page or site level. Properly configured metadata helps search engines understand your content and creates compelling previews when your pages are shared on social platforms. Keep titles between 50-60 characters and descriptions between 150-160 characters for optimal display in search results and social shares. +Configure SEO metadata at the page or site level to improve search visibility and social media previews for your documentation. Keep titles between 50-60 characters and descriptions between 150-160 characters for optimal display. ## Page metadata