Add SEO descriptions to event catalog and API reference pages#824
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Add SEO descriptions to event catalog and API reference pages#824mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
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 538 MDX pages for SEO and metadata quality. Found 243 pages missing a
descriptionfrontmatter field across two areas:event-catalog/(webhook event reference pages)api-reference/data/timeseries/(timeseries GET endpoint pages)All titles were already present and under 60 characters. No titles needed changes.
Changes
Added a
descriptionfrontmatter field to each affected page with a plain-language summary between 50–160 characters that accurately reflects the page content:daily.data.*.created/.updated— data ingestion / update events from connected providershistorical.data.*.created— historical backfill completion eventsprovider.connection.*/provider.device.*— provider lifecycle eventslabtest.*/lab_report.parsing_job.*/continuous_query.*— tailored descriptions per eventSnippets 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 passedmint broken-links— no broken links