Add SEO descriptions to API reference and event catalog pages#843
Open
mintlify[bot] wants to merge 1 commit into
Open
Add SEO descriptions to API reference and event catalog pages#843mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
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
Audit found 243 documentation pages missing the
descriptionfrontmatter field, which hurts SEO and search snippets. This PR adds descriptions for all of them, each between 50–160 characters.Changes
api-reference/data/timeseries/now have descriptions explaining what data each endpoint retrieves (e.g. heart rate, glucose, sleep stages, etc.).event-catalog/now have descriptions explaining when each webhook event is triggered, covering:daily.data.*.createdevents (new data ingested)daily.data.*.updatedevents (existing data updated)historical.data.*.createdevents (historical data sync completion)Only frontmatter was modified — page content is untouched. All other pages already had complete and reasonable metadata. Snippet files in
snippets/were intentionally left alone since they are reusable components, not pages.Validation
mint validate— passedmint broken-links— passed