Skip to content

Fix Vale style warnings: passive voice and punctuation#4057

Merged
ethanpalm merged 2 commits intomainfrom
fix-vale-warnings-1772767145
Mar 6, 2026
Merged

Fix Vale style warnings: passive voice and punctuation#4057
ethanpalm merged 2 commits intomainfrom
fix-vale-warnings-1772767145

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Mar 6, 2026

Summary

Fixes Vale style warnings identified by the CI check across 13 documentation files.

Changes made

  • Passive voice to active voice: Converted passive constructions to active voice in component documentation
  • Punctuation: Fixed quotation mark punctuation in navigation.mdx to follow American English style
  • Heading updates: Minor heading text adjustments for clarity

Files modified

  • api-playground/adding-sdk-examples.mdx
  • api-playground/multiple-responses.mdx
  • components/badge.mdx
  • components/banner.mdx
  • components/callouts.mdx
  • components/color.mdx
  • components/examples.mdx
  • components/responses.mdx
  • contact-support.mdx
  • customize/fonts.mdx
  • dashboard/audit-logs.mdx
  • optimize/feedback.mdx
  • organize/navigation.mdx

Warnings not addressed (require human review)

The following Vale warnings were identified but not fixed as they may require content decisions:

  1. Acronym spelling: Vale flags acronyms like SLA, PST, TLS, CAA, RSS, WCAG without definitions, but these are commonly understood in their contexts
  2. Heading capitalization: Some headings use proper nouns (Adobe Launch, Google Fonts) which Vale incorrectly flags
  3. First-person in examples: Sample questions like "how do I..." intentionally use first person
  4. Passive voice in descriptions: Some passive constructions are appropriate for describing states or conditions
  5. Changelog file: Excluded from Vale per .vale.ini configuration

Note

Low Risk
Low risk: documentation-only copy edits with no functional or configuration changes, aside from minor heading text that could affect anchors/links if referenced externally.

Overview
Updates docs copy to resolve Vale style warnings by rewriting several sentences from passive to active voice and tightening phrasing across API playground and component reference pages.

Also makes small clarity tweaks like renaming a couple headings (for example Email supportContact via email, Email collectionCollect email addresses) and adjusting punctuation (including the Latest, Recommended, or Beta list in navigation.mdx).

Written by Cursor Bugbot for commit 0b397cf. This will update automatically on new commits. Configure here.

- Convert passive voice to active voice in multiple component docs
- Fix quotation mark punctuation in navigation.mdx
- Update heading text to use correct casing
Style-only changes that don't affect content meaning.
Generated-By: mintlify-agent
@ethanpalm ethanpalm merged commit ad11bc2 into main Mar 6, 2026
5 checks passed
@ethanpalm ethanpalm deleted the fix-vale-warnings-1772767145 branch March 6, 2026 17:11
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