Add SEO frontmatter descriptions to MDX pages#2588
Closed
mintlify[bot] wants to merge 2 commits into
Closed
Conversation
Add or rewrite the description frontmatter for 261 hand-written documentation pages so each one has a unique 50-160 character summary suitable for search engines and link previews. Auto-generated reference pages (CLI, Python and TypeScript SDKs, query panel, support tag indexes) are intentionally excluded so the next generator run does not overwrite the new descriptions. Generated-By: mintlify-agent
Contributor
Knowledgebase navigation update
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (308 total)📄 Pages (308)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-mintlify-seo-descriptions-1777594747.mintlify.app |
Contributor
|
Lets do this next month, maybe |
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
1 participant
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 missing, short (under 50 characters), and long (over 160 characters)
descriptionfrontmatter values, then added or rewrote descriptions on 261 hand-written pages so every one has a unique 50–160 character summary suitable for search engines and link previews.What changed
models/runs/delete-runs.mdx,platform/hosting/managing-bucket-storage.mdx,platform/hosting/monitoring-usage/mobile-app.mdx.sandboxes/create-sandbox.mdx,sandboxes/secrets.mdx.blog.mdx,courses.mdx,pricing.mdx,security.mdx,support.mdx,sandboxes.mdx), product redirect pages (product-*.mdx),ref-link-*.mdxredirect wrappers, and thesupport/{models,inference,weave}redirect pages.platform/launchFAQ and library pages.support/inference/articles/, all 16support/weave/articles/, and all 189support/models/articles/knowledge-base pages.Results
The audit went from 434 OK / 446 missing / 39 short / 3 long to 695 OK / 0 long / 0 short on hand-written pages. The remaining "missing" pages are all auto-generated reference docs (W&B Python SDK, CLI, query panel, Weave Python and TypeScript SDKs, KB tag indexes) and were intentionally excluded so the next generator run does not overwrite the new descriptions.
What was not changed
description(and a few collapsed multi-linetitle:fields needed to keep YAML valid).Validation
mint validate— passes.mint broken-links— no broken links.