Skip to content

Vale style audit: fix style issues and narrow two rules - #7490

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/5467f428
Sep 24, 2026
Merged

ethanpalm merged 3 commits into
mainfrom
mintlify/5467f428

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Vale audit of English MDX lines added by PRs merged Sep 17–24, 2026 (57 commits, ~66 files). The vale binary isn't installed in this environment. I checked the lines against the .vale/styles/Mintlify/ rules with a script that follows .vale.ini: TokenIgnores, skipped code/kbd/link scopes, frontmatter, and es//fr//zh/ excluded.

Changes

Vocabulary (accept.txt, alphabetized)

  • WebMCP: browser API name used in ai/model-context-protocol.mdx and reference/glossary.mdx. No existing Web* entry matches it.
  • narratable: Mintlify narration term in assistant/narration.mdx and credits.mdx.

Spelling (prose)

  • agent/slack.mdx: "sidepanel" → "side panel" in the heading and body. The same paragraph already uses "Slack side panel".

Prose fixes

  • Mintlify.EmDash matched " — " twice in help-center/agent-opens-pull-requests-against-deploy-branch.mdx. I removed the spaces and kept the dash.
  • Mintlify.WordList ("above" → "preceding") matched "any rule above" and "the list above" in analytics/traffic-classification.mdx. Both point back to earlier content, so they now say "any preceding rule" and "the preceding list".
  • Mintlify.Semicolons matched ; in "Save the automation first; the trigger card…" (automations/manage.mdx) and in "render normally; the broken page…" (help-center/publish-button-disabled-invalid-mdx.mdx). Each is now split into two sentences.

Translations

  • The two semicolon splits are mirrored in the es/, fr/, and zh/ versions of automations/manage.mdx and help-center/publish-button-disabled-invalid-mdx.mdx.
  • The other English changes needed no translation. The translated pages already say "side panel", already use colons instead of the spaced dashes, and already use "preceding" wording.

Rule fixes

  • Mintlify.WordList "above" swap matched "does not rank HTML above Markdown" (analytics/traffic-classification.mdx). Here "above" means higher priority, not earlier on the page. "Rank HTML preceding Markdown" is wrong English.
    • I added the lookbehind (?<!\brank(?:s|ed|ing)? \w+ ).
    • Regex test: "rank HTML above Markdown" and "ranked JSON above HTML" are no longer flagged. "any rule above", "the list above", and "the example above" are still flagged.
  • Mintlify.Acronyms flagged RSS, AVIF, BMP, and MOV. These are well-known format names, like the existing GIF, PNG, ICO, and PDF exceptions. Spelling them out would make the sentences worse. I added all four to exceptions.

Other checks

  • Broken links: mint broken-links passes.
  • SEO: titles and descriptions of the changed pages pass every check. analytics/traffic-classification.mdx is hidden: true, so I skipped it.
  • Typos and writing style: nothing further to fix on the changed lines.

Needs human review

  • Mintlify.Passive (suggestion level) fired 21 times. Most hits are natural passives where the actor doesn't matter or is already named: "when no text is selected", "are hidden", "is cached", "cannot be narrated", "is served … by any preceding rule", "was started", "is disabled", "be changed", "is created", "are generated", "are categorized", "are removed", "being read", "be previewed", "is marked", "be selected", "is fetched".
    • I didn't rewrite any of them.
    • At 21 hits in about 630 added lines, the rule is noisy. Consider keeping it at suggestion and leaving it out of any CI gate.
  • The audit used a stand-in for Vale's hunspell dictionary. Spelling results for common words (for example "Emojis", "unexpired", "committers") couldn't be confirmed. A real vale run should confirm whether any of them need vocabulary entries.

Note

Low Risk
Documentation and Vale style configuration only; no product code, auth, or data-handling changes.

Overview
This PR tightens Mintlify Vale linting and applies the resulting prose fixes across English docs (with matching punctuation edits in es, fr, and zh).

Lint config: Adds WebMCP and narratable to the accepted vocabulary; adds AVIF, BMP, MOV, and RSS to acronym exceptions; and narrows the above → preceding WordList rule so phrases like “rank HTML above Markdown” are no longer rewritten incorrectly.

Doc copy: Standardizes “side panel” in Slack agent docs; replaces spaced em dashes with colons in related-settings links; changes backward references from “above” to preceding in traffic classification; splits semicolon-heavy sentences in automation webhook and invalid-MDX help topics into two sentences (including localized versions).

Reviewed by Cursor Bugbot for commit b441214. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Sep 24, 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 24, 2026, 3:48 PM

Comment thread help-center/agent-opens-pull-requests-against-deploy-branch.mdx Outdated
@ethanpalm
ethanpalm merged commit e8d21c0 into main Sep 24, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the mintlify/5467f428 branch September 24, 2026 15:49

This branch was successfully deployed

1 active deployment
staging — b441214d Deployed Sep 24, 2026 by mintlify[bot]
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