Skip to content

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

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

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

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 24, 2026

Summary

Audited all 538 MDX pages for SEO and metadata quality. Found 243 pages missing a description frontmatter field across two areas:

  • 192 files in event-catalog/ (webhook event reference pages)
  • 51 files in api-reference/data/timeseries/ (timeseries GET endpoint pages)

All titles were already present and under 60 characters. No titles needed changes.

Changes

Added a description frontmatter field to each affected page with a plain-language summary between 50–160 characters that accurately reflects the page content:

  • Event catalog: Descriptions explain when each webhook event is emitted. Patterns differ by category:
    • daily.data.*.created / .updated — data ingestion / update events from connected providers
    • historical.data.*.created — historical backfill completion events
    • provider.connection.* / provider.device.* — provider lifecycle events
    • labtest.* / lab_report.parsing_job.* / continuous_query.* — tailored descriptions per event
  • API reference timeseries: Descriptions explain that each endpoint retrieves grouped timeseries data for a specific metric across a user's connected wearable providers. Clinical abbreviations (ECG, HRV, FEV1, IgE, IgG) are spelled out where helpful.

Snippets files under snippets/ were intentionally skipped — they are reusable content fragments included in other pages and are not standalone documentation.

Validation

  • mint validate — build validation passed
  • mint broken-links — no broken links
  • Re-audit shows 0 remaining standalone pages with missing / out-of-range titles or descriptions

@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, 4:33 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