Add SEO descriptions to API reference and event catalog pages#862
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Add SEO descriptions to API reference and event catalog pages#862mintlify[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 MDX pages for SEO and metadata quality and added missing
descriptionfrontmatter to 243 pages that previously had none. All other pages already had complete and reasonable titles and descriptions.Changes
api-reference/data/timeseries/*.mdx): added descriptions explaining what each timeseries endpoint retrieves and the data sources involved.event-catalog/*.mdx): added descriptions explaining what each webhook event signals (daily data, historical backfills, lab tests, provider connections, etc.).All new descriptions are between 50 and 160 characters and accurately summarize the page content. No page content was modified — only frontmatter.
Audit results
After this change, all pages have:
titleunder 60 charactersdescriptionbetween 50 and 160 charactersThe remaining files flagged by the audit are all in
snippets/(reusable partials embedded in other pages, not standalone pages) and are intentionally excluded.Validation
mint validate— passedmint broken-links— passed