Add SEO descriptions to event catalog pages#823
Merged
Conversation
Adds a concise description frontmatter field to all 192 event catalog webhook event pages. Each description summarizes in plain language when the webhook fires and what data or lifecycle change it represents, improving SEO and search result snippets for these reference pages. Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited all MDX pages for SEO/metadata quality and found that 192 pages in
event-catalog/had atitlebut nodescriptionfrontmatter field. No other pages had missing, too-short, or too-long titles/descriptions.This PR adds a concise description (all between 50 and 160 characters) to each of those 192 webhook event reference pages. Each description summarizes in plain language when the event fires and what it represents.
What changed
daily.data.{resource}.created— Describes the event as firing when new resource data is added to a user's daily summary.daily.data.{resource}.updated— Describes the event as firing when existing resource data in the daily summary is updated.historical.data.{resource}.created— Describes the event as firing when Junction completes the historical backfill for a resource after a provider is connected.provider.connection.*,provider.device.*,labtest.*,lab_report.*,continuous_query.result_table.changed— Tailored descriptions reflecting each event's specific lifecycle semantics (connection, device, lab order/appointment/result, parsing job, continuous query).Scope
snippets/were intentionally not modified because they are content fragments included into other pages, not standalone documentation pages.mint validateandmint broken-linksboth pass.