Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 21, 2025

Add generator names to changelog page titles for SEO

Summary

Added index.mdx files with frontmatter to all SDK generator changelog directories to set SEO-friendly page titles while keeping the sidebar navigation labels as "Changelog". This improves SEO by making changelog pages more discoverable with search queries like ".NET SDK changelog" or "Python SDK changelog".

Approach:

  • Created index.mdx files in each changelog directory with frontmatter title field
  • Fern's page title generation uses frontmatter.title as priority over the navigation title field
  • Result: Browser tab and HTML <title> show "TypeScript SDK Changelog" while sidebar still shows "Changelog"

Files changed:

  • Added 8 index.mdx files (one per SDK: TypeScript, Python, Go, Java, .NET, PHP, Ruby, Swift)

Review & Testing Checklist for Human

  • Verify page titles in preview deployment: Open changelog pages for multiple SDK generators (TypeScript, .NET, Python) and confirm the browser tab shows "[Language] SDK Changelog | Fern Documentation"
  • Verify sidebar labels unchanged: Confirm the sidebar navigation still shows "Changelog" (not "[Language] SDK Changelog")
  • Check for unexpected changelog entries: Ensure the index.mdx files don't appear as separate entries in the changelog listing
  • Test HTML title tag: Use browser dev tools or curl to verify the <title> tag contains the SDK name (e.g., <title>.NET SDK Changelog | Fern Documentation</title>)

Notes

  • Tested locally with fern docs dev and verified with curl that page titles are correct
  • This approach leverages Fern's frontmatter title priority over navigation title (discovered through code investigation of packages/fern-docs/bundle/src/components/seo.ts)
  • If the index.mdx files cause any issues (e.g., appearing as entries), we may need to explore alternative approaches or request a feature from the Fern team to support separate navigation labels and page titles for changelogs

Link to Devin run: https://app.devin.ai/sessions/d5c47d6ae06e483dab6181a138fcb880
Requested by: Niels Swimberghe (@Swimburger)

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

@Swimburger
Copy link
Member

Let's add SDK in the title too, TypeScript SDK Changelog for example

@github-actions
Copy link
Contributor

@Swimburger
Copy link
Member

Swimburger commented Oct 21, 2025

Problem! It also says TypeScript SDK Changelog inside of the sidebar navigation. Only the browser title should change, not the navigation item text.

Screenshot 2025-10-21 at 5 41 30 PM

@github-actions
Copy link
Contributor

@Swimburger Swimburger merged commit 08cfb3d into main Oct 21, 2025
2 checks passed
@Swimburger Swimburger deleted the devin/1761082177-add-generator-names-to-changelog-titles branch October 21, 2025 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants