Update SEO and metadata audit workflow example#5542
Merged
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
approved these changes
Apr 27, 2026
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
Updates the SEO and metadata audit example prompt in
agent/workflows.mdxto 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:
openapi:frontmatter, including an explicit rule that an existingdescription:in frontmatter is treated as an intentional override of the spec's description.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 auditexample prompt inagent/workflows.mdxto 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.