Skip to content

Add SEO descriptions to API reference and event catalog#873

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

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

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 7, 2026

Summary

Adds missing description frontmatter to 243 documentation pages so they appear well in search results and Mintlify navigation snippets.

Changes

  • 51 timeseries API reference pages (api-reference/data/timeseries/*.mdx): Each now describes the specific timeseries metric retrieved by the endpoint (e.g. heart rate, glucose, blood pressure).
  • 192 event catalog pages (event-catalog/*.mdx): Each webhook event page now has a description summarizing when the event fires and what data it relates to. Covers daily.data.*.created, daily.data.*.updated, historical.data.*.created, plus lab test, provider connection, and continuous query events.

SEO criteria applied

  • All descriptions are between 50 and 160 characters.
  • No titles exceed 60 characters.
  • Descriptions summarize page content in plain language without changing any page body content.

Skipped

The 11 files in snippets/ were intentionally not modified — they are reusable content fragments imported into other pages, not standalone navigation pages, so SEO frontmatter does not apply to them.

Validation

  • mint validate passes
  • mint broken-links passes

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 7, 2026

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

Project Status Preview Updated (UTC)
Junction 🟢 Ready View Preview May 7, 2026, 9:09 AM

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