Skip to content

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

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

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

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 28, 2026

Summary

Audited all MDX docs for SEO/metadata quality. Added missing description frontmatter to 243 pages and corrected a few title casings. No content changes.

Findings

  • 244 pages were missing description frontmatter (50 timeseries API reference pages and 192 event catalog pages, plus hypnogram.mdx).
  • A few timeseries titles used incorrect casing (IgeIgE, IggIgG, Vo2 MaxVO2 Max, Calories ActiveActive Calories, Calories BasalBasal Calories, Heart Rate Recovery One MinuteHeart Rate Recovery, Wheelchair PushWheelchair Pushes, NoteNotes, FallFalls).
  • All titles were within the 60-character limit; no long titles found.
  • All existing descriptions were within 50–160 characters; no length issues found in pre-existing metadata.
  • 10 files in snippets/ have no frontmatter — these are reusable include components rather than navigable pages, so they were intentionally left untouched.

Changes

  • API reference (50 files): Added descriptions of the form Retrieve time-series <resource> for a user from the Vital API. and normalized titles where needed.
  • Event catalog (192 files): Added descriptions tailored to each webhook event family:
    • daily.data.*.created / .updated
    • historical.data.*.created
    • labtest.*, lab_report.*, provider.*
    • continuous_query.result_table.changed

All descriptions are between 50 and 160 characters and accurately summarize each page's purpose.

Validation

  • mint validate passed.
  • mint broken-links passed.
  • Re-running the audit confirms zero outstanding issues across navigable pages.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 28, 2026

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

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