Vale style audit: fix em-dash spacing and tune Acronyms/kbd scopes - #6968
Open
mintlify[bot] wants to merge 2 commits into
Open
Vale style audit: fix em-dash spacing and tune Acronyms/kbd scopes#6968mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Audit of English MDX files touched by PRs merged 2026-08-06 through 2026-08-13: fix real style hits and tighten two rules that were over-matching.
Changes
Prose fixes
Mintlify.EmDash— Remove spaces around em-dashes in bullet definition lists (term — desc→term—desc). 185 incustomize/custom-scripts.mdx, 8 inorganize/settings-seo.mdx, 4 inassistant/use.mdx.Mintlify.WordListapi-playground/sdk-reference-setup.mdx: "the tab or group above them" → "the parent tab or group" (matches "above" → "preceding"; "parent" reads more naturally for hierarchy inheritance).assistant/use.mdx: "the hostnames above" → "the preceding hostnames".assistant/widget.mdx: "stylesheet" → "style sheet".dashboard/sso.mdx: Wrap the Okta UI valueMatches regexin backticks soregexsits in an ignored scope rather than reword a verbatim UI label.Mintlify.Quotes—guides/knowledge-base.mdx: move terminal period inside the closing quote of an example prompt.Mintlify.Will—enterprise-contracting.mdx: "We will warrant in writing" → "We warrant in writing" (drops the hedge; the surrounding clause already uses simple present).Rule changes
.vale.ini— AddkbdtoIgnoredScopes. Content of<kbd>tags is a keyboard character, not prose.<kbd>I</kbd>was firingMintlify.FirstPersoninassistant/use.mdx,contact-support.mdx,editor/agent.mdx, andeditor/keyboard-shortcuts.mdx. The rule still fires on proseI/me/myoutside<kbd>..vale/styles/Mintlify/Acronyms.yml— Add 34 exceptions for acronyms already used unexplained throughout the docs:ACS,AEO,ANSI,AWS,CAA,CDN,CIDR,CNAME,CSP,CTA,CTR,DNS,DOCX,GEO,HEAD,IAM,ISO,JSONC,MCP,MDX,NAT,OAI,OIDC,PATCH,PUT,RBAC,ROI,RPC,SCIM,SEO,TLS,TOML,TSV,TXT,UTC,WAVE,YYYY. These already live in theMintlifyvocabulary; the rule's separateexceptions:list was silently drifting behind it and produced 371 "spell out" suggestions in the audited files. Unknown 3–5 letter acronyms still fire.For human review
Mintlify.OxfordComma(10 hits, all false positives) — The pattern(?:[^,]+,){1,}\s\w+\s(?:and|or)counts any comma as a list separator, so it fires on date commas (July 31, 2026 or later), conditional-clause commas (If this key type is unavailable, your organization…), and parenthetical commas (in meta tags, globally or per-page,), even when the sentence already has correct Oxford commas. All 10 flagged sentences inai/mintlify-mcp.mdx,analytics/streaming.mdx,analytics/user-engagements.mdx,api/search-index/introduction.mdx,assistant/widget.mdx,help-center/domain-already-claimed-by-another-organization.mdx,optimize/seo.mdx, andquickstart.mdxare correct as written. Consider lowering the level or narrowing the pattern to exclude date literals and known clause markers; I didn't touch it here because I can't run Vale in the sandbox to verify a replacement pattern doesn't silently break the rule.Mintlify.FirstPersonon link text like[My profile](agent/index.mdx:38,deploy/github.mdx:139) — "My profile"/"My Profile" is the literal name of a dashboard page. Rewording the link text would misidentify the UI. Vale may already ignore markdown link text viaIgnoredScopes = a; if not, the narrowest fix is to add link-text scope handling toMintlify.FirstPerson. Left untouched.Mintlify.FirstPersonon## Iinreference/glossary.mdx:111— Single-letter section heading used as an alphabet marker in the glossary. Edge case; not worth a rule carve-out unless more glossaries appear.Notes
.vale/styles/Mintlify/*.ymldirectly, so alert counts are approximate but the classifications above reflect the actual prose.es/,fr/, andzh/were not scanned (Vale is disabled there via.vale.ini).{/* vale off */}blocks, or nested code fences were treated as scanner false positives and left alone.Note
Low Risk
Changes are limited to Vale configuration and documentation copy/formatting; no application code, auth, or data handling paths are modified.
Overview
Tightens Vale so lint matches how the docs already read, then applies the resulting fixes across English and localized MDX.
Rule/config:
.vale.iniignoreskbdscopes (keyboard shortcuts in<kbd>were tripping first-person rules).Mintlify/Acronyms.ymladds 34 acronym exceptions aligned with the Mintlify vocabulary so common terms (e.g.MDX,DNS,OIDC) no longer spam “spell out” suggestions.Prose (English + mirrored
es/,fr/,zh/where the diff shows): Definition lists incustomize/custom-scripts.mdxswitch from spaced em-dashes (term — desc) to no-space em-dashes (term—desc). Similar list formatting updates land inorganize/settings-seo.mdxand assistant hostname bullets. Small wording fixes: SDK nav inheritance uses parent tab/group; assistant copy uses preceding hostnames; widget CSP text uses style sheet; enterprise contracting drops “will warrant”; knowledge-base example prompt punctuation; Okta SAML table keeps UI labelMatches regexin backticks.Risk: Documentation and linter configuration only—no runtime product behavior.
Reviewed by Cursor Bugbot for commit e871402. Bugbot is set up for automated code reviews on this repo. Configure here.