Skip to content

Add SEO descriptions to timeseries and event pages#836

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

Add SEO descriptions to timeseries and event pages#836
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/seo-frontmatter-1777308532

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 27, 2026

Summary

Audited all 538 MDX files in the docs for SEO/metadata quality and added missing description frontmatter to 243 pages that previously had none.

What changed

  • 51 timeseries reference pages (api-reference/data/timeseries/*.mdx) — added descriptions explaining what each metric endpoint returns (heart rate, blood pressure, glucose, sleep stages, etc.).
  • 192 event-catalog pages (event-catalog/*.mdx) — added descriptions for daily.data.*.created, daily.data.*.updated, historical.data.*.created, lab test events, provider connection events, and continuous query events. Descriptions clarify when each webhook fires.

All new descriptions are between 50 and 160 characters and accurately summarize the page's content in plain language. No page content was modified — only frontmatter additions.

Audit results

Before:

  • 1 file missing title (snippet — intentional)
  • 244 files missing description

After:

  • 0 pages missing or with out-of-range titles
  • 0 pages with out-of-range descriptions
  • The remaining file without title/description (snippets/historical-pull-limits.mdx) is a snippet imported into other pages, not a standalone route, so it does not need SEO frontmatter.

Validation

  • mint validate — passed
  • mint broken-links — no broken links

Success criteria

All non-snippet pages now have a title under 60 characters and a description between 50 and 160 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, 5:15 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