Skip to content

Add SEO descriptions to timeseries and event catalog pages#827

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-descriptions-1777051001
Open

Add SEO descriptions to timeseries and event catalog pages#827
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-descriptions-1777051001

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 24, 2026

Summary

Audited all 538 MDX files for SEO and metadata quality. Found 243 pages missing a description frontmatter field after the most recent auto-regeneration of the event catalog and timeseries endpoint docs overwrote previously-added descriptions.

This PR restores concise, plain-language descriptions (all between 50 and 160 characters) to each of those pages. Descriptions were sourced from the previously-approved versions in PRs #823 and #825.

What changed

  • Added description frontmatter to 51 timeseries API reference pages under api-reference/data/timeseries/ (e.g. afib-burden.mdx, glucose.mdx, heartrate.mdx). Each follows the existing API reference style: "Retrieve [metric] timeseries data for a specific user, grouped by source provider."
  • Added description frontmatter to 192 webhook event reference pages under event-catalog/ (e.g. daily.data.activity.created.mdx, historical.data.heartrate.created.mdx, provider.connection.created.mdx). Each summarizes in plain language when the event fires and what it represents.
  • Only frontmatter was modified — no page content was changed.

Not changed

  • 10 files in snippets/ have no frontmatter, but these are reusable fragments imported into other pages (not rendered as standalone pages), so frontmatter is not applicable.
  • No pages had titles exceeding 60 characters, descriptions shorter than 50 characters, or descriptions longer than 160 characters.

Validation

  • mint validate — build validation passed
  • mint broken-links — no broken links found

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 24, 2026

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

Project Status Preview Updated (UTC)
Junction 🟢 Ready View Preview Apr 24, 2026, 5:19 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