Vale style audit: fix style issues and narrow two rules - #7490
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
reviewed
Sep 24, 2026
ethanpalm
approved these changes
Sep 24, 2026
This branch was successfully deployed
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
Vale audit of English MDX lines added by PRs merged Sep 17–24, 2026 (57 commits, ~66 files). The
valebinary 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, andes//fr//zh/excluded.Changes
Vocabulary (
accept.txt, alphabetized)WebMCP: browser API name used inai/model-context-protocol.mdxandreference/glossary.mdx. No existingWeb*entry matches it.narratable: Mintlify narration term inassistant/narration.mdxandcredits.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.EmDashmatched" — "twice inhelp-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" inanalytics/traffic-classification.mdx. Both point back to earlier content, so they now say "any preceding rule" and "the preceding list".Mintlify.Semicolonsmatched;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
es/,fr/, andzh/versions ofautomations/manage.mdxandhelp-center/publish-button-disabled-invalid-mdx.mdx.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.(?<!\brank(?:s|ed|ing)? \w+ ).Mintlify.AcronymsflaggedRSS,AVIF,BMP, andMOV. These are well-known format names, like the existingGIF,PNG,ICO, andPDFexceptions. Spelling them out would make the sentences worse. I added all four toexceptions.Other checks
mint broken-linkspasses.analytics/traffic-classification.mdxishidden: true, so I skipped it.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".suggestionand leaving it out of any CI gate.valerun 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.