Skip to content

docs: fix Vale warnings in pages updated last week#5883

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
docs/vale-warnings-week-2026-05-21
Open

docs: fix Vale warnings in pages updated last week#5883
mintlify[bot] wants to merge 2 commits into
mainfrom
docs/vale-warnings-week-2026-05-21

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 21, 2026

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-spellcheck CI check.

Scope

Reviewed all 13 PRs merged to mintlify/docs between 2026-05-14 and 2026-05-21. After excluding translated-only PRs, config/PDF-only PRs, and the changelog.mdx (which is explicitly disabled in .vale.ini via BasedOnStyles = ""), the English files touched were:

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 / ## Breadcrumbs headings and Dropdowns 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 tags in 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,215Sidebar anchor links. / Dropdown menus. as short one-line property descriptions. Same start-of-sentence issue.

json substring in filenames

  • organize/navigation.mdx:3:117, organize/settings-reference.mdx:2:14, 3:49docs.json filename. Vale's json → JSON rule matches the substring. Changing it would break the filename.

Rebase (rule: Did you really mean 'Rebase'?)

  • editor/settings.mdx:115Rebase is 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:74the Getting started group is hidden and the Guides group is visible is a stative description of state, not an action. Rewriting changes the meaning.

Emphatic uppercase

  • organize/hidden-pages.mdx:144does NOT apply is deliberate emphasis in a precedence note contrasting two behaviors. Lowercasing weakens the contrast.

Excluded by config but still surfaced by CI

  • changelog.mdx.vale.ini sets BasedOnStyles = "" 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.ini or 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.mdx to use clearer, more active phrasing around publishing settings, per-user AI instructions, and the default merge method.

Adjusts the ES/FR organize/settings-reference.mdx text for navigation.directory and api.params.post to 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 21, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 21, 2026, 3:16 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 21, 2026

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

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview May 21, 2026, 3:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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