Skip to content

Fix Vale style violations#3583

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771608121
Closed

Fix Vale style violations#3583
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771608121

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 20, 2026

Summary

This PR addresses Vale style violations found during an audit of the MDX documentation files.

Auto-fixed issues (errors)

File Line Rule Fix
changelog.mdx 465 Exclamation Removed exclamation point from "Starter questions for assistant are here!"
changelog.mdx 1325 EmDash Removed spaces around em-dash
dashboard/audit-logs.mdx 22 WordList Changed "click on" to "click"

Issues requiring human judgment (warnings/suggestions)

File Line Rule Issue
changelog.mdx Multiple Will 83 uses of "will" detected (style suggests using present tense)
Various files Multiple Passive Passive voice detected in multiple locations
Various files Multiple OxfordComma Some sentences may benefit from Oxford comma
Various files Multiple Headings Some headings use Title Case instead of sentence case

Note: The warning-level issues above are subjective and context-dependent. Many "will" usages are appropriate for describing future behavior or features. The heading capitalization exceptions include proper nouns and technical terms that are correctly capitalized.

Excluded from this audit

  • Files in language subdirectories (es/, fr/, zh/)
  • Code blocks and JSON examples
  • Technical terms and proper nouns

Note

Low Risk
Only minor copy edits in MDX docs to satisfy Vale linting; no functional or behavioral changes.

Overview
Fixes a few Vale style violations in MDX documentation.

Updates changelog.mdx to remove an exclamation and tighten em-dash spacing, and tweaks dashboard/audit-logs.mdx wording from “Click on” to “Click” for style consistency.

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

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