Skip to content

Fix Vale style warnings from CI checks#4348

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/vale-fixes-1773262443
Mar 12, 2026
Merged

Fix Vale style warnings from CI checks#4348
ethanpalm merged 3 commits into
mainfrom
mintlify/vale-fixes-1773262443

Conversation

@mintlify-development
Copy link
Copy Markdown
Contributor

@mintlify-development mintlify-development Bot commented Mar 11, 2026

Summary

  • Converted passive voice to active voice in multiple documentation files
  • Updated Vale vocabulary and acronym exceptions to reduce false positives
  • Fixed "file path" → "path" per WordList substitution rule

Files modified

Documentation fixes

  • organize/settings.mdx: Changed passive voice "are replaced" and "are sanitized" to active voice
  • organize/pages.mdx: Changed "file path" to "path"
  • organize/navigation.mdx: Changed passive voice "is used" and "can be nested" to active voice
  • installation.mdx: Changed passive voice "are reported" to active voice
  • ai/model-context-protocol.mdx: Changed passive voice "are protected" to active voice
  • agent/use-cases.mdx: Changed passive voice "are added" to active voice
  • advanced-support.mdx: Changed passive voice "is delivered" to active voice

Vale configuration updates

  • .vale/styles/config/vocabularies/Mintlify/accept.txt: Added "hostname" and "VPN"
  • .vale/styles/Mintlify/Acronyms.yml: Added SLA, PST, and VPN to exceptions
  • .vale/styles/Mintlify/Headings.yml: Added Discord, Slack, CSM, and FAQ to heading exceptions

Warnings not addressed (require human review)

  • llms.txt references: Vale flags llms in file names and headings like "llms.txt structure" as needing capitalization. These are intentional references to the llms.txt standard file naming convention.
  • "bot's" in ai/discord.mdx: Vale incorrectly flags the possessive form as a spelling error. The text "bot's default name" is correct.
  • "Changelog" heading capitalization: Vale flags "Changelog" in a heading as needing lowercase, but this refers to the proper noun (a Changelog post type).
  • "informat" in agent/workflows.mdx: This is a false positive - the text says "Include information" which is correctly spelled.

Note

Low Risk
Low risk: changes are limited to documentation wording tweaks and Vale lint configuration exception lists, with no runtime or product behavior impact.

Overview
Resolves Vale CI style warnings by rewriting several docs sentences from passive to active voice and making small clarity/wording adjustments in MDX pages (support FAQs, agent use cases, MCP access notes, CLI broken-links behavior, and navigation docs).

Updates Vale style configuration to reduce false positives by expanding exception lists for acronyms and heading capitalization (e.g., PST, SLA, VPN, CSM, Discord, Slack, FAQ).

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

Generated-By: mintlify-agent
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Comment thread .vale/styles/config/vocabularies/Mintlify/accept.txt Outdated
Comment thread .vale/styles/config/vocabularies/Mintlify/accept.txt Outdated
Comment thread organize/pages.mdx Outdated
@ethanpalm ethanpalm merged commit 1941f2c into main Mar 12, 2026
4 checks passed
@ethanpalm ethanpalm deleted the mintlify/vale-fixes-1773262443 branch March 12, 2026 00:10
mintlify Bot added a commit that referenced this pull request Mar 12, 2026
Generated-By: mintlify-agent
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