Add SEO descriptions to timeseries and event pages#836
Open
mintlify[bot] wants to merge 1 commit into
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 538 MDX files in the docs for SEO/metadata quality and added missing
descriptionfrontmatter to 243 pages that previously had none.What changed
api-reference/data/timeseries/*.mdx) — added descriptions explaining what each metric endpoint returns (heart rate, blood pressure, glucose, sleep stages, etc.).event-catalog/*.mdx) — added descriptions fordaily.data.*.created,daily.data.*.updated,historical.data.*.created, lab test events, provider connection events, and continuous query events. Descriptions clarify when each webhook fires.All new descriptions are between 50 and 160 characters and accurately summarize the page's content in plain language. No page content was modified — only frontmatter additions.
Audit results
Before:
After:
snippets/historical-pull-limits.mdx) is a snippet imported into other pages, not a standalone route, so it does not need SEO frontmatter.Validation
mint validate— passedmint broken-links— no broken linksSuccess criteria
All non-snippet pages now have a title under 60 characters and a description between 50 and 160 characters.