Skip to content

Improve docs meta descriptions - #198

Open
naman06dev wants to merge 2 commits into
mainfrom
agent/fix-meta-descriptions
Open

naman06dev wants to merge 2 commits into
mainfrom
agent/fix-meta-descriptions

Conversation

@naman06dev

Copy link
Copy Markdown

Summary

  • add unique 150–160 character meta descriptions to all active documentation and knowledge-base MDX pages
  • add meaningful leading summaries for generated API endpoint, webhook event, and WebSocket pages
  • improve the site-wide Open Graph fallback and changelog landing description
  • add a reusable SEO metadata check and run it as part of npm run lint

Why

Bing Webmaster Tools reports that many documentation pages have meta descriptions that are too short. Fern falls back to page subtitles or endpoint documentation, which caused some routes to emit short snippets, bare CLI commands, or no HTML description.

These changes give search engines and AI retrieval systems clearer, page-specific summaries while preventing future regressions.

Impact

  • validates 77 MDX pages and 117 generated API pages
  • rejects missing, duplicate, or non-150–160-character descriptions
  • preserves existing page content and CLI examples while improving generated metadata

Validation

  • npm run lint
  • npm run lint:seo
  • npx -y fern-api@latest check (0 errors; existing route-overlap warnings remain)
  • git diff --check

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

✨ API Changes

No changelog changes

💡 Download api-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@naman06dev
naman06dev marked this pull request as ready for review August 6, 2026 14:45
@naman06dev
naman06dev requested a review from bbnoy August 6, 2026 14:45
@bbnoy
bbnoy requested a review from Haakam21 August 8, 2026 23:33
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.

1 participant