Add consolidated SEO overview page with tabs #3427
Conversation
…on, canonical tags, and social metadata Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### Overriding canonical URLs | ||
|
|
||
| To manually set a canonical URL for a specific page, use the `canonical-url` frontmatter field: |
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.
|
|
||
| Social metadata controls how your pages appear when shared on platforms like LinkedIn, Slack, Discord, and Twitter/X. | ||
|
|
||
| ### Open Graph tags |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Open Graph tags' should use sentence-style capitalization.
|
|
||
| Open Graph (OG) tags control previews on LinkedIn, Slack, Discord, and other platforms. Fern automatically generates these tags from your page content, but you can customize them. | ||
|
|
||
| #### Page-level Open Graph settings |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Page-level Open Graph settings' should use sentence-style capitalization.
| ``` | ||
| </CodeBlock> | ||
|
|
||
| #### Site-level Open Graph settings |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Site-level Open Graph settings' should use sentence-style capitalization.
| ``` | ||
| </CodeBlock> | ||
|
|
||
| ### Twitter Card tags |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Twitter Card tags' should use sentence-style capitalization.
| ``` | ||
| </CodeBlock> | ||
|
|
||
| #### Site-level Twitter settings |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Site-level Twitter settings' should use sentence-style capitalization.
| The `twitter:card` field accepts these values: `summary`, `summary_large_image`, `app`, or `player`. | ||
|
|
||
| </Tab> | ||
| <Tab title="URL best practices"> |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'URL best practices' should use sentence-style capitalization.
|
|
||
| Well-structured URLs improve SEO and user experience. Fern automatically generates clean URLs from your navigation structure. | ||
|
|
||
| ### URL formatting |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'URL formatting' should use sentence-style capitalization.
| <CodeBlock title="docs.yml"> | ||
| ```yaml | ||
| redirects: | ||
| - source: "/old-path" |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'old' that become outdated
| redirects: | ||
| - source: "/old-path" | ||
| destination: "/new-path" | ||
| - source: "/old-folder/:slug" |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'old' that become outdated
Summary
Creates a new consolidated SEO documentation page that organizes SEO topics into tabs, addressing a customer request for clear documentation on SEO capabilities. The new page covers:
headlineanddescriptionfrontmatter, site-level defaultscanonical-url, site-levelcanonical-hostThe navigation is updated to show "SEO overview" as the first item in the SEO section.
Review & Testing Checklist for Human
/learn/docs/seo/metadatais no longer in navigation but the filemetadata.mdxstill exists. Decide if a redirect should be added from the old URL to/learn/docs/seo/overview/learn/docs/seo/configuring-slugs,/learn/docs/seo/redirects,/learn/docs/configuration/page-level-settings, and/learn/docs/configuration/site-level-settingswork correctly in the previewTest plan: Deploy preview and navigate to
/learn/docs/seo/overview, verify all tabs render correctly and internal links work.Notes
The old
metadata.mdxfile was not deleted - it may be worth removing it or adding a redirect to avoid duplicate content.Link to Devin run: https://app.devin.ai/sessions/7e6c3c770c614b3d8f203a07fbc763d0
Requested by: kenny