Skip to content

Fix Vale style warnings across documentation#4056

Closed
mintlify-development[bot] wants to merge 1 commit intomainfrom
fix-vale-warnings-1772767152
Closed

Fix Vale style warnings across documentation#4056
mintlify-development[bot] wants to merge 1 commit intomainfrom
fix-vale-warnings-1772767152

Conversation

@mintlify-development
Copy link
Contributor

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

Summary

This PR addresses Vale style warnings identified in CI checks from PRs merged in the last week.

Changes

Vale vocabulary updates:

  • Added common tech acronyms to exceptions: REST, RSS, TLS, VPN, SLA, RBAC, OAS, GEO, WAF, UTC
  • Added technical terms to vocabulary: hostname, allowlists, bot's, timeframe, impactful, unfixable, webtoken, noindex
  • Made LLMs case-insensitive to accept both 'LLMs' and 'llms'

Content fixes:

  • Fixed typo 'informat' in workflows.mdx
  • Converted passive voice to active voice in multiple files (feedback.mdx, markdown-export.mdx, adding-sdk-examples.mdx, multiple-responses.mdx, use-cases.mdx)
  • Fixed sentence-style capitalization in headings (expandables.mdx, monorepo.mdx, quickstart.mdx, contact-support.mdx, feedback.mdx, openapi-setup.mdx)
  • Changed 'file path' to 'path' per style guide (openapi-setup.mdx)
  • Fixed 'Autogenerate' to 'Autogenerated' (openapi-setup.mdx)
  • Fixed 'Strikethrough' capitalization in text.mdx

Not fixed (requires human review)

The following warnings were not addressed because they may require judgment or could change meaning:

  • changelog.mdx (89 warnings): Most are sentence-style capitalization in product release headings (e.g., "Web Editor 3.0", "AI Translations in beta"). These appear intentional as product names.
  • First-person pronouns: Some uses in guides (geo.mdx, support-center.mdx, knowledge-base.mdx) may be intentional for conversational tone
  • Semicolon usage: Some semicolons in code examples and technical content may be intentional
  • "above/below" references: Some spatial references in component docs may be clearer than "preceding/following"

Note

Low Risk
Low risk: changes are limited to Vale lint configuration updates and small copy/heading tweaks in MDX docs, with no runtime or behavioral code changes.

Overview
Resolves Vale CI style warnings by expanding .vale acronym exceptions (e.g., REST, TLS, RBAC, UTC) and adding/adjusting accepted vocabulary terms (including case-insensitive LLMs?).

Applies small doc copy edits across several MDX pages to match style guidance (active-voice rewrites, sentence-case heading/title normalization, and a few terminology/capitalization tweaks such as file pathpath and Strikethrough casing).

Written by Cursor Bugbot for commit 6bf3eac. 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