Skip to content

Update SEO and metadata audit workflow example#5542

Merged
ethanpalm merged 1 commit intomainfrom
mintlify/seo-audit-prompt-1777312216
Apr 27, 2026
Merged

Update SEO and metadata audit workflow example#5542
ethanpalm merged 1 commit intomainfrom
mintlify/seo-audit-prompt-1777312216

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 27, 2026

Summary

Updates the SEO and metadata audit example prompt in agent/workflows.mdx to mirror the improvements shipped to the dashboard's SEO & metadata audit workflow template.

What changed

The example prompt now uses a clearer structure with explicit Process / Checks / Writing guidance / Success criteria / Constraints sections, and includes:

  • A four-phase workflow (Discover, Plan, Fix, PR) so the agent gathers the full picture before editing.
  • Expanded checks for duplicate titles, plus more specific examples of boilerplate titles to flag.
  • Clearer handling of pages with openapi: frontmatter, including an explicit rule that an existing description: in frontmatter is treated as an intentional override of the spec's description.
  • A constraint that prohibits deleting, renaming, or moving files.

Why

The dashboard's built-in SEO & metadata audit workflow template received the same prompt improvements. Keeping the documented example in sync ensures users who copy the example get the improved behavior.


Note

Low Risk
Low risk docs-only change that rewrites an example prompt; main risk is users may follow updated OpenAPI/frontmatter override guidance differently than before.

Overview
Updates the SEO and metadata audit example prompt in agent/workflows.mdx to a more structured format with explicit Process, Checks, Writing guidance, Success criteria, and Constraints sections.

The checks are expanded to cover duplicate titles/descriptions and more explicit boilerplate-title detection, and OpenAPI handling is clarified to treat existing description: frontmatter as an intentional override while still deferring to spec metadata when no override exists.

Adds tighter constraints around only editing frontmatter, never moving/deleting files, and doing nothing (including not opening a PR) when all pages already meet the criteria.

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

@mintlify-development
Copy link
Copy Markdown
Contributor

mintlify-development Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
userauth 🔴 Failed Apr 27, 2026, 5:52 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Apr 27, 2026, 5:51 PM

@ethanpalm ethanpalm merged commit 1b828ca into main Apr 27, 2026
5 of 6 checks passed
@ethanpalm ethanpalm deleted the mintlify/seo-audit-prompt-1777312216 branch April 27, 2026 17:52
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.

1 participant