Skip to content

Comments

style: Vale audit fix and manual review recommendations#3726

Merged
ethanpalm merged 1 commit intomainfrom
vale-audit-1771964056
Feb 24, 2026
Merged

style: Vale audit fix and manual review recommendations#3726
ethanpalm merged 1 commit intomainfrom
vale-audit-1771964056

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Feb 24, 2026

Summary

Ran a comprehensive Vale style audit on all MDX files (excluding zh/, es/, fr/, and changelog.mdx).

Auto-fixed

  • Replaced "above" with "preceding" in deploy/route53-cloudfront.mdx per Vale WordList rule

Issues 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:

File Line Text
api-playground/troubleshooting.mdx 101 "only the explicitly referenced operations will appear"
api-playground/troubleshooting.mdx 107 "Navigation entries...will be treated as file paths"
deploy/ghes.mdx 233 "The app will need to be re-approved"
guides/assistant-embed.mdx 8 "What you will build" (heading)
guides/automate-agent.mdx 8 "What you will build" (heading)
guides/understand-your-audience.mdx 42 "There will always be edge cases"
guides/windsurf.mdx 16 "they will not be consistent"
installation.mdx 275 "You will be prompted for your password"
integrations/analytics/google-analytics.mdx 41 "The extension will log to your browser's console"
integrations/privacy/osano.mdx 51 "resources...will load even when Osano blocks"
migration-services/enterprise.mdx 114 "we will implement it"
migration-services/enterprise.mdx 120 "our team will work with you"
quickstart.mdx 162 "preview how your pages will look"

Other "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

  • ✅ No broken links found

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.

@ethanpalm ethanpalm merged commit 411395a into main Feb 24, 2026
5 checks passed
@ethanpalm ethanpalm deleted the vale-audit-1771964056 branch February 24, 2026 21:03
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