docs: document what Fern auto-generates for SEO metadata #1751
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
Contributor
Author
🤖 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}
| The metadata configurations on this page are for SEO and social tags that aren't visible to users. For visible footer links, see [footer links configuration](/learn/docs/configuration/what-is-docs-yml#footer-links-configuration). | ||
| </Note> | ||
|
|
||
| ## What Fern auto-generates |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Auto] In general, don't hyphenate 'auto-generates'.
Contributor
Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
Contributor
kgowru
approved these changes
Nov 4, 2025
devalog
approved these changes
Nov 4, 2025
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document what Fern automatically generates for SEO metadata
Summary
Added a new section "What Fern automatically generates" to the SEO metadata documentation page that explicitly lists all the SEO metadata tags Fern auto-generates for every documentation page. This addresses user confusion about what's automatically handled versus what needs manual configuration.
The new section covers:
Technical details were derived from code review of
generateMetadataFromPage()andgenerateMetadataFromConfig()infern-platform/packages/fern-docs/bundle/src/components/seo.ts.Review & Testing Checklist for Human
<head>sectionTest plan: Navigate to the preview deployment, open browser DevTools on any docs page, inspect the
<head>section, and verify that the metadata tags listed in the new section are actually present in the HTML output.Notes