Vale style audit: acronym and heading exceptions, prose fixes - #7395
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
approved these changes
Sep 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix Vale alerts found on English MDX files changed between 2026-09-10 and 2026-09-17.
Changes
agent/slack.mdx: move terminal period inside the closing quote (Mintlify.Quotes).help-center/register-external-mcp-server-in-discovery.mdx: drop the hyphen inexternally-hosted(Mintlify.LyHyphens)..vale/styles/Mintlify/Acronyms.yml): addDRY,GHES,RFC, andSVGRto the exceptions list. Each is a widely recognized technical acronym used in the affected pages (create/reusable-snippets.mdx,help-center/ip-addresses-for-git-provider-allowlists.mdx,api-playground/openapi-setup.mdx,snippets/icons-optional.mdx). Spelling them out inline would harm readability in each context (e.g.,DRY (Don't Repeat Yourself)appears inline but doesn't match Vale'sWords (ACR)expansion pattern). Adding them to exceptions rather than rewording preserves the natural prose..vale/styles/Mintlify/Headings.yml): addConfluence,Entra,Git, andReactto the exceptions list. These are product/tool proper nouns flagged as needing sentence-case in headings likeMigrate Confluence content manually,Microsoft Entra,Core Git concepts, andImport React components. Capitalizing them is correct; the rule was over-matching.Uncertain (not changed)
Mintlify.Passive(47 hits): level=suggestion. Every match is a defensible use of passive voice describing what Mintlify does automatically (is generated,are excluded,is validated). Rewriting them into active voice would either name a vague actor or make the sentences less accurate. Flagging for human review whether to lower this rule's level or leave prose alone.Mintlify.FirstPersonon quoted sample questions ("How do I set up authentication?","how do I submit an expense report"): the "I"/"my" appears inside example user queries the reader would type. Changing them defeats the purpose of the example. Consider narrowingFirstPersonto skip content inside quotation marks.Mintlify.HeadingsonCheck the Don't index project setting(help-center/llms-txt-returns-404-but-llms-full-txt-works.mdx): "Don't index project" is the exact UI toggle name, so capitalization is intentional. Unsure whether Vale's$sentencematcher actually fires here (apostrophe handling varies).Mintlify.Semicolonsin table cells (automations/integrations.mdx): semicolons separate list items inside single table cells. Level=suggestion; reformatting the tables into bulleted lists would be a larger content change.Mintlify.Spacingoncomponents/icons.mdx:30: only fires against my emulator because inline JSX<Icon .../>was not fully stripped. Actual Vale withTokenIgnoresshould not flag this.Context
Vale binary is unavailable in the sandbox, so this run evaluated the rule definitions in
.vale/styles/Mintlify/directly against the changed files. Rule changes were verified by inspecting the exception lists and confirming the new entries only bypass the specific false positives (e.g.,Gitin exceptions still letsMintlify.HeadingsflagGithubor lowercase mid-sentencegit).Note
Low Risk
Documentation and Vale style config only; no runtime or product behavior changes.
Overview
Updates Mintlify Vale rules and fixes a few MDX prose alerts from a recent English docs audit.
Vale exceptions:
Acronyms.ymlnow allows DRY, GHES, RFC, and SVGR without requiring inline “spelled out (ACR)” expansions.Headings.ymlexempts Confluence, Entra, Git, and React so product/tool names in headings aren’t flagged for sentence case.Copy edits: In
agent/slack.mdx, the example quote places the period inside the closing quote (Mintlify.Quotes). Inhelp-center/register-external-mcp-server-in-discovery.mdx, externally hosted drops the hyphen in the title and body (Mintlify.LyHyphens).Reviewed by Cursor Bugbot for commit f40da4a. Bugbot is set up for automated code reviews on this repo. Configure here.