style: Vale audit fix and manual review recommendations#3726
Merged
Conversation
Generated-By: mintlify-agent
ethanpalm
approved these changes
Feb 24, 2026
This was referenced Feb 24, 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
Ran a comprehensive Vale style audit on all MDX files (excluding
zh/,es/,fr/, andchangelog.mdx).Auto-fixed
deploy/route53-cloudfront.mdxper Vale WordList ruleIssues requiring human judgment
The codebase is well-maintained with no error-level Vale violations in prose. The following warning-level patterns were identified for optional review:
"Will" usage (warning)
The Vale style guide suggests avoiding future tense. These instances may benefit from present tense rewording:
api-playground/troubleshooting.mdxapi-playground/troubleshooting.mdxdeploy/ghes.mdxguides/assistant-embed.mdxguides/automate-agent.mdxguides/understand-your-audience.mdxguides/windsurf.mdxinstallation.mdxintegrations/analytics/google-analytics.mdxintegrations/privacy/osano.mdxmigration-services/enterprise.mdxmigration-services/enterprise.mdxquickstart.mdxOther "above" usages (valid, kept as-is)
These uses of "above" are idiomatic or describe visual positioning and don't warrant replacement:
guides/index.mdx:8- "Above all else" (idiom)guides/navigation.mdx:66- "Above all" (idiom)components/frames.mdx:35- "appear above the frame" (visual)components/tooltips.mdx:22- "displayed above" (visual)editor/configurations.mdx:77- "labels above page titles" (visual)Validation
Note
Low Risk
Single-word documentation change with no effect on product behavior or configuration guidance.
Overview
Updates the AWS Route 53 + CloudFront deployment guide to replace “above steps” with “preceding steps” in the behaviors verification section for style-guide compliance.
Written by Cursor Bugbot for commit 7f99750. This will update automatically on new commits. Configure here.