Add SEO & GEO overview page and expand SEO metadata best practices#3725
Add SEO & GEO overview page and expand SEO metadata best practices#3725fern-api[bot] wants to merge 5 commits intomainfrom
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,45 @@ | |||
| --- | |||
| title: Overview of SEO & GEO | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GEO' has no definition.
| description: Understand Fern's built-in features for search engine optimization (SEO) and generative engine optimization (GEO) to maximize the reach and discoverability of your documentation. | ||
| --- | ||
|
|
||
| Fern optimizes your documentation for both traditional search engines and AI-powered tools out of the box. SEO ensures your pages rank well in Google, Bing, and other search engines, while GEO (Generative Engine Optimization) ensures AI tools like ChatGPT, Claude, and Cursor can efficiently consume and reference your content. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GEO' has no definition.
|
🌿 Preview your docs: https://fern-preview-aff23d37-41b4-44fc-b732-ef50ce7f1a34.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
| </ParamField> | ||
|
|
||
| <ParamField path="metadata.canonical-host" type="string" required={false} toc={true}> | ||
| The host of your documentation website. Used to set the canonical URL for metadata tags and documents like the sitemap. Defaults to the URL defined in `instances`. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.URLFormat] Use 'of' (not 'for') to describe the relationship of the word URL to a resource.
| </ParamField> | ||
|
|
||
| <ParamField path="metadata.og:image:width" type="number" required={false} toc={true}> | ||
| The width of your Open Graph image in pixels. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Units] Don't spell out the number in 'in pixels'.
| </ParamField> | ||
|
|
||
| <ParamField path="metadata.og:image:height" type="number" required={false} toc={true}> | ||
| The height of your Open Graph image in pixels. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Units] Don't spell out the number in 'in pixels'.
| URL to your company logo. | ||
| </ParamField> | ||
|
|
||
| ### Twitter / X |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Twitter / X' should use sentence-style capitalization.
devin-ai-integration
bot
changed the title
1 participant
Summary
Adds a new overview page to the SEO & GEO section (
/learn/docs/seo/overview) with cards linking to existing pages and contextual information about both SEO and GEO capabilities. Modeled after the authentication overview page.Changes:
fern/products/docs/pages/seo/overview.mdxfern/products/docs/docs.ymlto add the Overview entry at the top of the SEO & GEO sectionfern/products/docs/pages/seo/metadata.mdxwith additional best practices contentOverview page structure:
llms.txtand AI featuresUpdates since last revision
Review & Testing Checklist for Human
/learn/docs/seo/setting-seo-metadata,/learn/docs/seo/configuring-slugs,/learn/docs/seo/redirects/learn/docs/ai-features/llms-txtand/learn/docs/ai-features/overviewworkRecommended test plan: Use the preview deployment to verify the overview page renders correctly, all cards link to the right destinations, and the expanded SEO metadata page reads well. Confirm the sidebar navigation shows Overview at the top of the SEO & GEO section.
Notes