Add SEO descriptions to timeseries and event catalog pages#827
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Add SEO descriptions to timeseries and event catalog pages#827mintlify[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 files for SEO and metadata quality. Found 243 pages missing a
descriptionfrontmatter field after the most recent auto-regeneration of the event catalog and timeseries endpoint docs overwrote previously-added descriptions.This PR restores concise, plain-language descriptions (all between 50 and 160 characters) to each of those pages. Descriptions were sourced from the previously-approved versions in PRs #823 and #825.
What changed
descriptionfrontmatter to 51 timeseries API reference pages underapi-reference/data/timeseries/(e.g.afib-burden.mdx,glucose.mdx,heartrate.mdx). Each follows the existing API reference style: "Retrieve [metric] timeseries data for a specific user, grouped by source provider."descriptionfrontmatter to 192 webhook event reference pages underevent-catalog/(e.g.daily.data.activity.created.mdx,historical.data.heartrate.created.mdx,provider.connection.created.mdx). Each summarizes in plain language when the event fires and what it represents.Not changed
snippets/have no frontmatter, but these are reusable fragments imported into other pages (not rendered as standalone pages), so frontmatter is not applicable.Validation
mint validate— build validation passedmint broken-links— no broken links found