docs: fix Vale warnings in pages updated last week#5883
Open
mintlify[bot] wants to merge 2 commits into
Open
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
Applies safe Vale style fixes to English MDX pages that were touched by PRs merged in the past week and that had outstanding warnings from the
Mintlify Validation - vale-spellcheckCI check.Scope
Reviewed all 13 PRs merged to
mintlify/docsbetween 2026-05-14 and 2026-05-21. After excluding translated-only PRs, config/PDF-only PRs, and thechangelog.mdx(which is explicitly disabled in.vale.iniviaBasedOnStyles = ""), the English files touched were:editor/settings.mdx(PR docs: add editor settings page for AI and publishing #5810)workflows/index.mdx(PR Rename workflows overview page and boost search #5828)organize/navigation.mdx(PR Remove flags from supported languages list #5830)organize/hidden-pages.mdx,optimize/seo.mdx(PR docs: document searchable for hidden tabs and groups #5837)optimize/search.mdx(PR docs: convert search-boost into general Search config page #5851 — no Vale warnings reported)changelog.mdx,organize/pages.mdx,organize/settings-reference.mdx(PRs docs: convert search-boost into general Search config page #5851 / docs: add May 15 2026 changelog entry #5820)deploy/github.mdx(PR fix: remove tip to only give workflows access to docs repos #5799 — no Vale warnings reported)Vale warnings were deduplicated against the CI output on commit
ad6162664a9bf7acf5ba65d2ff1a98be547dfa36(the most recent vale-spellcheck run, covering all merged work).Changes
editor/settings.mdx: Rewrote four passive-voice constructions in active voice (lines 10, 23, 57, 117).organize/settings-reference.mdx: Split a semicolon-joined sentence into two, and converted one passive-voice clause to active voice.Warnings intentionally left unfixed (need human review)
The following warnings were reviewed and not changed because a mechanical fix would either change meaning, conflict with English style, or introduce inconsistency.
Em-dash spacing (
Don't put a space before or after a dash.)workflows/index.mdx:23,24— em-dash (—) with spaces is standard English style for parenthetical em-dashes; Vale appears to flag em-dashes the same as hyphens. The same pattern is used throughout the repo.organize/settings-reference.mdx:247— same em-dash pattern in a type signature.Vocab substitutions at start of sentence / heading
organize/navigation.mdx:442,444,1013,1015—## Dropdowns/## Breadcrumbsheadings andDropdowns are…/Breadcrumbs display…sentence starts. Vale wants lowercase (dropdowns,breadcrumbs), but sentence-style capitalization at the start of a heading or sentence is correct.organize/pages.mdx:17—- Sidebar titles, icons, and tagsin a list of bullets that all start with capitalized nouns (- Page titles…,- Page layouts). Lowercasing only this one would be inconsistent.organize/settings-reference.mdx:157,163,209,215—Sidebar anchor links./Dropdown menus.as short one-line property descriptions. Same start-of-sentence issue.jsonsubstring in filenamesorganize/navigation.mdx:3:117,organize/settings-reference.mdx:2:14, 3:49—docs.jsonfilename. Vale'sjson → JSONrule matches the substring. Changing it would break the filename.Rebase(rule:Did you really mean 'Rebase'?)editor/settings.mdx:115—Rebaseis the literal label of a Git merge method shown in the editor UI. Renaming it would misrepresent the product.Passive voice / stative passives
organize/hidden-pages.mdx:74—the Getting started group is hidden and the Guides group is visibleis a stative description of state, not an action. Rewriting changes the meaning.Emphatic uppercase
organize/hidden-pages.mdx:144—does NOT applyis deliberate emphasis in a precedence note contrasting two behaviors. Lowercasing weakens the contrast.Excluded by config but still surfaced by CI
changelog.mdx—.vale.inisetsBasedOnStyles = ""for this file, but the CI still reports ~150 warnings against it. Either the CI uses a different config or the override isn't being honored. Skipped because the repo configuration says these should not be enforced — flagging so the team can decide whether.vale.inior the CI is the source of truth.Validation
mint validate✅mint broken-links✅Note
Low Risk
Low risk documentation-only wording tweaks in Spanish and French, primarily rephrasing for clarity/active voice with no behavioral or schema changes.
Overview
Updates the Spanish and French versions of
editor/settings.mdxto use clearer, more active phrasing around publishing settings, per-user AI instructions, and the default merge method.Adjusts the ES/FR
organize/settings-reference.mdxtext fornavigation.directoryandapi.params.postto improve readability (splitting a semicolon sentence and clarifying which values Mintlify omits), without changing any documented types or defaults.Reviewed by Cursor Bugbot for commit dd4dfa1. Bugbot is set up for automated code reviews on this repo. Configure here.