Add SEO descriptions to event catalog pages#822
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
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 documentation pages for SEO metadata quality. Found that all 192 pages in
event-catalog/were missingdescriptionfrontmatter.Changes
Added
descriptionfrontmatter to every page inevent-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 availabledaily.data.<type>.updated— existing current-day data is updatedhistorical.data.<type>.created— historical backfill completion after a user connects a providerprovider.connection.*/provider.device.*— connection and device lifecycle eventslabtest.*/lab_report.*— lab ordering, appointment, parsing, and critical result eventscontinuous_query.result_table.changed— Continuous Query result change eventsAudit results
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— passedmint broken-links— passedNotes