Skip to content

Add SEO descriptions to API reference and event catalog pages#859

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-metadata-1777574349
Open

Add SEO descriptions to API reference and event catalog pages#859
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-metadata-1777574349

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 30, 2026

Summary

Audited all MDX pages for SEO metadata quality and added missing description frontmatter to 243 pages. Every page now has a descriptive, search-friendly summary between 50–160 characters.

What changed

  • API reference – timeseries (50 pages): Added descriptions for endpoints under api-reference/data/timeseries/*, e.g. heart rate, glucose, steps, HRV, blood pressure, sleep stages, etc. Each describes what the endpoint returns (a per-metric grouped timeseries for a user).
  • Event catalog – daily data (~95 pages): Added descriptions for every daily.data.*.created and daily.data.*.updated webhook event page, explaining when the event fires and what payload it carries.
  • Event catalog – historical data (~50 pages): Added descriptions for every historical.data.*.created page, explaining that they fire after a historical backfill completes.
  • Event catalog – misc (12 pages): Added descriptions for labtest.*, provider.connection.*, provider.device.*, lab_report.parsing_job.*, and continuous_query.result_table.changed.

Audit summary

Check Before After
Pages missing description 244 0
Pages with description <50 chars 0 0
Pages with description >160 chars 0 0
Pages missing title 0 (excluding snippets) 0
Pages with title >60 chars 0 0

Files under snippets/ are reusable content fragments imported into other pages and are not standalone documentation pages, so they correctly remain without frontmatter and were intentionally excluded from this audit.

Notes

  • Only frontmatter was modified. No page body content was changed.
  • All titles were already within the 60-character limit, so no title changes were needed.
  • Validated with mint validate and mint broken-links — both pass.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 30, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Junction 🟢 Ready View Preview Apr 30, 2026, 6:42 PM

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.

0 participants