Skip to content

Apply SEO and metadata best practices - #6791

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/0f72fed9
Closed

Apply SEO and metadata best practices#6791
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/0f72fed9

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Improve the quickstart page title so it describes the specific content instead of using a one-word generic label.

Changes

  • quickstart.mdx: expand title from "Quickstart" to "Quickstart: Deploy your Mintlify documentation site" (51 chars) — describes the page's specific content and includes searchable terms.
  • snippets/setup-agent-prompt.mdx: no changes — it is an imported snippet with no frontmatter and is not an indexed page.
  • Description on quickstart.mdx already meets the 130–160 character target and remains unchanged.

Note

Low Risk
Single frontmatter metadata change on one docs page with no runtime or application logic impact.

Overview
Updates the quickstart page frontmatter title from the generic "Quickstart" to "Quickstart: Deploy your Mintlify documentation site" so browser tabs, navigation, and search results reflect what the guide actually covers.

No body copy, description, or keywords change in this diff.

Reviewed by Cursor Bugbot for commit f0f6cd7. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
mintlify Bot requested review from N43527 and ethanpalm July 28, 2026 21:04

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit f0f6cd7. Configure here.

Comment thread quickstart.mdx
@@ -1,5 +1,5 @@
---
title: "Quickstart"
title: "Quickstart: Deploy your Mintlify documentation site"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing short sidebar title

Medium Severity

Expanding title for SEO without adding sidebarTitle leaves the full 51-character string in primary nav. Elsewhere in this repo, long SEO titles pair with a short sidebarTitle (for example on optimize/feedback.mdx and guides/assistant-embed.mdx), so the Get started sidebar will show the long label instead of a concise Quickstart.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit f0f6cd7. Configure here.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 28, 2026, 9:06 PM

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 28, 2026, 9:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 28, 2026, 9:04 PM

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 28, 2026, 9:04 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ethanpalm ethanpalm closed this Jul 28, 2026
@ethanpalm
ethanpalm deleted the mintlify/0f72fed9 branch July 28, 2026 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants