docs: fix Vale warnings from PRs merged in the last week#6153
Merged
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. |
ethanpalm
reviewed
Jun 11, 2026
ethanpalm
approved these changes
Jun 11, 2026
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jun 11, 2026
mintlify Bot
added a commit
that referenced
this pull request
Jun 11, 2026
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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 and remediate Vale spellcheck warnings surfaced by the
Mintlify Validation (mintlify) - vale-spellcheckcheck across the 39 PRs merged intomintlify/docssince 2026-06-04. Findings were deduplicated by file and filtered to English-only files (translations underes/,fr/,zh/andchangelog.mdxare excluded by.vale.ini, so warnings on those paths are out of scope).Changes
Style fixes
assistant/index.mdx:9— passive "is enabled by default" → "is on by default" (Vale:Mintlify.Passive).deploy/cloudflare.mdx:125— passive "your main site is set up" → imperative "Set up your main site…" (Vale:Mintlify.Passive).guides/internationalization.mdx:743— two passive "should/be translated" instances rewritten in active voice (Vale:Mintlify.Passive).migration-services/pro.mdx:70— Card titleFunctionality→Features(Vale:Mintlify.WordList"functionality" → "capability|feature").Vocabulary additions
Three legitimate English words that Vale flagged as misspellings (
Vale.Spelling"Did you really mean 'X'?") were added to.vale/styles/config/vocabularies/Mintlify/accept.txt:sandboxed— used incustomize/react-components.mdx:71scrollable— used incustomize/custom-scripts.mdx:82, 87unmerged— used inworkflows/reference.mdx:17This follows the precedent set in #6131 (adding new technical terms to the accept list rather than rewriting copy).
Items flagged for human review
The remaining Vale findings from the audited PRs appear to be false positives or context-dependent calls that I am not confident enough to fix without risking a meaning change. Listing them here for a human pass:
Sentence-case headings flagged as needing lowercase
The
Vale.Vocab/WordListsubstitution rules are case-sensitive against the accept list, so they fire on perfectly correct sentence-case headings.organize/navigation.mdx:442, 444—## Dropdowns("Use 'dropdowns?' instead of 'Dropdowns'.")organize/navigation.mdx:1014, 1016—## Breadcrumbsorganize/pages.mdx:17—<Tooltip tip="Sidebar">-style heading flagged ("Use 'sidebars?' instead of 'Sidebar'.")create/image-embeds.mdx:181—## Iframescustomize/custom-scripts.mdx— multiple<Accordion title="Dropdown">,<Accordion title="Sidebar">, etc. accordion category labels (lines 125, 133, 149, 173, 231, 258, 271)organize/settings-reference.mdx:157, 163, 209, 215— same patternorganize/settings-structure.mdx:185— same patternThese look correct as-is. Consider either (a) loosening the WordList rule to
ignorecase: trueor (b) adding heading-only exceptions."agents" vs "AGENTS"
Vale flags every lowercase
agentsbecauseAGENTS(the filenameAGENTS.md) is in vocab in that exact case. Rewriting the noun "agents" (referring to AI agents in prose) toAGENTSwould be wrong. Affected lines includeai/model-context-protocol.mdx:17, 29, 34, 39, 43, 85andworkflows/create.mdx:28. Suggest the sameignorecase: true/ vocab rework as above."above" used spatially, not positionally
Mintlify.WordListrewritesabove→preceding, which is correct for "see the table above" but wrong for spatial usage. Currently false-positive on:customize/custom-scripts.mdx:67("Announcement banner displayed above the navbar.")customize/custom-scripts.mdx:171("Small label displayed above a page title.")Code/JSX content that Vale's
TokenIgnoresdidn't catchcreate/image-embeds.mdx:11, 12—className,httpsinside a fenced HTML/JSX block.create/image-embeds.mdx:135— multiple semicolons inside an HTMLallow=attribute value (accelerometer; autoplay; …).create/image-embeds.mdx:89— "pointer cursor" describing the CSS cursor, not the IDE.create/redirects.mdx:3— frontmatterdescriptionmentionsdocs.json(the filename, not the language name); Vale'sJSON/jsonsubstitution shouldn't apply here.organize/settings-reference.mdx:2, 3andorganize/settings-structure.mdx:3— samedocs.jsonfilename issue.customize/react-components.mdx:75— ellipsis inside a code span`export const MyComponent = ...`; should be skipped bySkippedScopes = code.Quoted user/example text
agent/slack.mdx:78—"How do I set up authentication?"(example user question, first-person is intentional).guides/linking.mdx:218— Oxford-comma rule fires on "bookmarked and shared links" (only two items; rule misfires).guides/internationalization.mdx:665, 667, 669—.pngextensions appearing inside a fenced code block file tree;Vale.Spelling/case rule incorrectly triggered."are read-only" parsed as passive
ai/model-context-protocol.mdx:171— "tools are read-only" —read-onlyis a compound adjective, not the passive verb form. False positive onMintlify.Passive.Other ambiguous cases
customize/react-components.mdx:74— "cannot be imported" inside a bulleted constraint list. Rewriting to active voice would require restructuring the bullet pattern; left as-is.organize/settings-reference.mdx:247— "Don't put a space before or after a dash" — wasn't able to confidently identify which dash; suggest a manual look.Validation
mint broken-links→ no broken links.mint validatereports the same pre-existingdocs.jsonschema error noted in docs: sync es/fr/zh translations with recent English updates #6140 (contextual.options[1] = 'download-spec'not in enum); unrelated to this PR.Note
Low Risk
Documentation-only edits to style guide vocabulary and copy; no runtime, auth, or product behavior changes.
Overview
Clears Vale spellcheck and style warnings from recent docs PRs by extending the Mintlify accept list and tightening prose in a few English MDX pages.
Vocabulary: Adds
sandboxed,scrollable, andunmergedto.vale/styles/config/vocabularies/Mintlify/accept.txtso legitimate technical terms in existing copy stop failingVale.Spelling.Style: Rewrites passive phrasing flagged by
Mintlify.Passive—assistant default state (assistant/index.mdx), Cloudflare Webflow deploy warning (deploy/cloudflare.mdx), and i18n FAQ guidance on code vs. surrounding text (guides/internationalization.mdx). Per the PR scope, amigration-services/pro.mdxcard title is also aligned with the word list (Functionality→Features).Many remaining Vale hits are documented as likely false positives (sentence-case headings, spatial “above”, code/JSX scopes) and are intentionally out of scope for this pass.
Reviewed by Cursor Bugbot for commit 75ffdbf. Bugbot is set up for automated code reviews on this repo. Configure here.