Skip to content

Fix Vale warnings from PRs merged in the last week#5502

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/fix-vale-warnings-1776957788
Closed

Fix Vale warnings from PRs merged in the last week#5502
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/fix-vale-warnings-1776957788

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 23, 2026

Summary

Audits all Vale spellcheck warnings from PRs merged to mintlify/docs in the last week (#5270 through #5501) and applies style-only fixes. Only actionable warnings that can be resolved without changing content meaning are fixed here. Low-confidence or false-positive warnings are listed under Not fixed for human review.

Source PRs audited

Warnings were pulled from the Mintlify Validation (mintlify) - vale-spellcheck check run on the head commit of each merged PR. Only English files are considered (Vale is disabled on es/, fr/, zh/, and changelog.mdx).

PRs audited: #5270, #5330, #5345, #5379, #5386, #5387, #5393, #5397, #5409, #5411, #5417, #5426, #5437, #5440, #5447, #5451, #5454, #5467, #5472, #5478, #5487, #5491, #5496

PRs that passed Vale with no warnings: #5345, #5393, #5437, #5447, #5478

Fixes applied

File Line Rule Change
agent/workflows.mdx 238, 257, 301 Mintlify.WordList (Croncron) **Trigger:** Cron schedule**Trigger:** cron schedule (3 occurrences)
cli/commands.mdx 244 Mintlify.Passive (is deprecated) The standalone \mint openapi-check` command is deprecated.Mintlify deprecated the standalone `mint openapi-check` command.`
guides/assistant-embed.mdx 8 Mintlify.Will (avoid will) Heading ## What you will build## What you build
guides/branches.mdx 11 Mintlify.Passive (is created, are made, is merged) Rewrote sentence in active voice without changing meaning

Not fixed

The warnings below were reviewed and intentionally not changed. Most are false positives caused by Vale's MDX parsing, UI labels, or quoted user input. The rest would require rewording that risks changing meaning and should be reviewed by a human.

False positives (context makes the rule incorrect)

  • api/analytics/feedback.mdx line 4 — Use 'JSON' instead of 'json'. The match is inside the openapi: /analytics.openapi.json filename reference in frontmatter, not prose.
  • api/analytics/feedback-by-page.mdx line 4 — same as above.
  • api/preview/trigger.mdx line 4 — Use 'JSON' instead of 'json'. Filename in openapi: frontmatter.
  • cli/commands.mdx line 3, 90 — Use 'Dev' instead of 'dev'. Matches the command name mint dev / # Disable telemetry code contexts.
  • cli/commands.mdx lines 144, 160 — '\```' should use sentence-style capitalization`. Vale parsed code-fence markers as headings.
  • cli/commands.mdx line 178 — Use 'subcommands?' instead of 'Subcommand'. Subcommand is a table column header.
  • cli/commands.mdx line 367 — Did you really mean 'informat'?. Misparse of the word information.
  • agent/workflows.mdx historical warnings — informat, be connected, Oxford comma on lines 216/218 — content has since been rewritten; these warnings no longer apply to the current file.
  • customize/custom-scripts.mdx lines 67, 171 — Use 'preceding' instead of 'above'. above is used spatially (displayed above the navbar, displayed above a page title), not referentially.
  • customize/custom-scripts.mdx lines 82, 87, 170, 217 — Did you really mean 'Scrollable'/'targetable'?. Both are real English words used correctly in component descriptions.
  • customize/custom-scripts.mdx lines 91, 110, 129, 125, 133, 149, 173, 231, 258, 271 — Use 'sidebars?'/'callouts?'/'eyebrow'/'dropdowns?'/'breadcrumbs?'/'popovers?' — all matches are inside <Accordion title="..."> UI labels or first-word descriptions after an em dash. Changing these would change rendered UI labels.
  • customize/custom-scripts.mdx line 136 — Passive ('is selected') in Tooltip that appears when text is selected on a page. — the state is the subject; rewording changes meaning.
  • editor/keyboard-shortcuts.mdx lines 96–98 — Use 'Cursor' instead of 'cursor'. The word refers to the text cursor, not the Cursor product.
  • editor/keyboard-shortcuts.mdx line 97 — Use 'preceding' instead of 'above'. Refers to the spatial direction (Add cursor above).
  • editor/pages.mdx line 58 — Use 'Mermaid' instead of 'mermaid'. The match is inside <kbd>/mermaid</kbd>, a command identifier.
  • editor/pages.mdx line 62 — Use 'Cursor' instead of 'cursor'. Refers to the text cursor.
  • editor/pages.mdx line 63 — Did you really mean 'shortcodes'?. Already accepted in the Vale vocabulary (added in Add emojis, shortcodes, and redeployment to Vale vocabulary #5476).
  • editor/pages.mdx line 103 — Use 'sidebars?' instead of 'Sidebar'. Sidebar title is a UI settings label.
  • guides/geo.mdx lines 8, 178–180 — Avoid first-person pronouns. Matches are inside quoted example questions users ask AI tools.
  • guides/geo.mdx lines 21, 23 — Use 'backlinks?'/'scannable' instead. Matches are inside a table header/cell.
  • guides/geo.mdx line 58 — don't use an ellipsis. Ellipsis is inside a fenced code block.
  • guides/assistant-embed.mdx lines 76, 120, 121, 125 — Use semicolons judiciously. Semicolons are JavaScript statement terminators inside code blocks.
  • guides/assistant-embed.mdx line 176 — Did you really mean 'handleSubmit'?. JavaScript identifier inside a code block.
  • guides/developer-documentation.mdx line 145 — first-person pronouns in a quoted sample user question.
  • guides/help-center.mdx line 182–184 — first-person pronouns in quoted sample user questions.
  • guides/knowledge-base.mdx line 180 — first-person pronoun in a quoted sample user question.
  • guides/internationalization.mdx lines 664, 666, 668 — Use 'PNG' instead of 'png'. Inside a file-tree code block.
  • deploy/authentication-setup.mdx lines 107, 108, 140 — Use 'endpoints?'/'logouts?'. Endpoint/Logout URL are dashboard field labels.
  • deploy/github.mdx lines 55, 129 — sentence-style capitalization. GitHub App is a proper noun (GitHub product name).
  • deploy/preview-deployments.mdx lines 46, 48, 51 — Use 'redeploy(s|ed|ing)?'. Sentence-start in heading/step list or UI button label.
  • api/introduction.mdx line 9 — Use 'endpoints?' instead of 'Endpoints'. First word of a heading, correctly sentence-cased.

Ambiguous – flagged for human review

  • cli/commands.mdx line 244 (the is deprecated passive). Fixed above, but alternate phrasings exist; reviewer may prefer The \mint openapi-check` command is no longer supported.` or similar.
  • guides/internationalization.mdx lines 742, 746 — Passive ('be translated', 'are configured'). Rewording would require attributing an actor that the sentences deliberately omit.
  • optimize/feedback.mdx line 84 — Passive ('has been resolved'). The sentence describes a feedback status label; rewording risks conflicting with the UI name of the status.
  • deploy/github.mdx line 146 — Passive ('are disabled'). Describes UI state.
  • deploy/preview-deployments.mdx line 17 — Passive ('are created'). Describes automatic behavior.
  • api/preview/trigger.mdx line 18 — Passive ('are opened'). Describes CI pull-request event trigger.
  • assistant/index.mdx line 8 — Passive ('is enabled'). Describes default state.
  • agent/workflows.mdx line 164 — Did you really mean 'informat'?. Likely misparse; leaving unchanged.

changelog.mdx

All changelog.mdx warnings reported against PR #5411 and #5431 were ignored — .vale.ini explicitly disables Vale styles on changelog.mdx (BasedOnStyles = ""), so these are not real CI failures.

Validation

  • mint broken-links: no broken links found.
  • mint validate: the pre-existing #.redirects: Invalid type error and localized-navigation schema errors are unrelated to this change.

Generated-By: mintlify-agent


Note

Low Risk
Low risk: changes are limited to minor wording/casing tweaks in documentation content only, with no behavioral or API implications. Risk is mainly small phrasing/consistency regressions in rendered docs.

Overview
Applies style-only documentation edits to resolve Vale warnings across a few MDX pages.

This standardizes cron casing in workflow trigger examples, rewrites a deprecation note in cli/commands.mdx in active voice, adjusts a heading in guides/assistant-embed.mdx, and rephrases a sentence in guides/branches.mdx to avoid passive voice without changing meaning.

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

@mintlify-development
Copy link
Copy Markdown
Contributor

mintlify-development Bot commented Apr 23, 2026

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

Project Status Preview Updated (UTC)
userauth 🟢 Ready View Preview Apr 23, 2026, 3:32 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 23, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 23, 2026, 3:31 PM

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.

2 participants