Skip to content

Add SEO descriptions to event catalog pages#822

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

Add SEO descriptions to event catalog pages#822
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-metadata-1777040758

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 24, 2026

Summary

Audited all MDX documentation pages for SEO metadata quality. Found that all 192 pages in event-catalog/ were missing description frontmatter.

Changes

Added description frontmatter to every page in event-catalog/. Each description is between 50 and 160 characters, written in plain language, and accurately summarizes what the webhook event represents.

Descriptions follow consistent patterns by event family:

  • daily.data.<type>.created — new data from the current day is available
  • daily.data.<type>.updated — existing current-day data is updated
  • historical.data.<type>.created — historical backfill completion after a user connects a provider
  • provider.connection.* / provider.device.* — connection and device lifecycle events
  • labtest.* / lab_report.* — lab ordering, appointment, parsing, and critical result events
  • continuous_query.result_table.changed — Continuous Query result change events

Audit results

Check Before After
Missing description 192 0
Description too short (<50) 0 0
Description too long (>160) 0 0
Missing title 0 0
Title too long (>60) 0 0

The 11 remaining files without frontmatter are all inside snippets/ — these are reusable content partials included by other pages, not standalone navigable pages, so they correctly do not need title/description metadata.

Validation

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

Notes

  • Only frontmatter was modified; no page content was changed.

Generated-By: mintlify-agent
@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, 2:29 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