Skip to content

Vale style audit: acronym and heading exceptions, prose fixes - #7395

Merged
ethanpalm merged 2 commits into
mainfrom
mintlify/b7a2d8a3
Sep 17, 2026
Merged

ethanpalm merged 2 commits into
mainfrom
mintlify/b7a2d8a3

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Fix Vale alerts found on English MDX files changed between 2026-09-10 and 2026-09-17.

Changes

  • Prose fixes:
    • agent/slack.mdx: move terminal period inside the closing quote (Mintlify.Quotes).
    • help-center/register-external-mcp-server-in-discovery.mdx: drop the hyphen in externally-hosted (Mintlify.LyHyphens).
  • Rule changes (.vale/styles/Mintlify/Acronyms.yml): add DRY, GHES, RFC, and SVGR to 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's Words (ACR) expansion pattern). Adding them to exceptions rather than rewording preserves the natural prose.
  • Rule changes (.vale/styles/Mintlify/Headings.yml): add Confluence, Entra, Git, and React to the exceptions list. These are product/tool proper nouns flagged as needing sentence-case in headings like Migrate Confluence content manually, Microsoft Entra, Core Git concepts, and Import 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.FirstPerson on 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 narrowing FirstPerson to skip content inside quotation marks.
  • Mintlify.Headings on Check 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 $sentence matcher actually fires here (apostrophe handling varies).
  • Mintlify.Semicolons in 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.Spacing on components/icons.mdx:30: only fires against my emulator because inline JSX <Icon .../> was not fully stripped. Actual Vale with TokenIgnores should 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., Git in exceptions still lets Mintlify.Headings flag Github or lowercase mid-sentence git).


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.yml now allows DRY, GHES, RFC, and SVGR without requiring inline “spelled out (ACR)” expansions. Headings.yml exempts 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). In help-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.

@mintlify

mintlify Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 17, 2026, 3:20 PM

@ethanpalm
ethanpalm merged commit 579d5d9 into main Sep 17, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the mintlify/b7a2d8a3 branch September 17, 2026 15:25
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