Skip to content

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

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/seo-frontmatter-1777332790
Open

Add SEO descriptions to API reference and event catalog pages#843
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/seo-frontmatter-1777332790

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 27, 2026

Summary

Audit found 243 documentation pages missing the description frontmatter field, which hurts SEO and search snippets. This PR adds descriptions for all of them, each between 50–160 characters.

Changes

  • 51 timeseries API reference pages in api-reference/data/timeseries/ now have descriptions explaining what data each endpoint retrieves (e.g. heart rate, glucose, sleep stages, etc.).
  • 192 event catalog pages in event-catalog/ now have descriptions explaining when each webhook event is triggered, covering:
    • 60 daily.data.*.created events (new data ingested)
    • 60 daily.data.*.updated events (existing data updated)
    • 60 historical.data.*.created events (historical data sync completion)
    • Lab test, lab report parsing, provider connection/device, and continuous query events

Only frontmatter was modified — page content is untouched. All other pages already had complete and reasonable metadata. Snippet files in snippets/ were intentionally left alone since they are reusable components, not pages.

Validation

  • mint validate — passed
  • mint broken-links — passed
  • All new descriptions are 50–160 characters and all titles remain under 60 characters

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
Junction 🟢 Ready View Preview Apr 27, 2026, 11:38 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