Fix Vale warnings from PRs merged in the last week#5502
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Fix Vale warnings from PRs merged in the last week#5502mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Audits all Vale spellcheck warnings from PRs merged to
mintlify/docsin 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-spellcheckcheck run on the head commit of each merged PR. Only English files are considered (Vale is disabled ones/,fr/,zh/, andchangelog.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
agent/workflows.mdxMintlify.WordList(Cron→cron)**Trigger:** Cron schedule→**Trigger:** cron schedule(3 occurrences)cli/commands.mdxMintlify.Passive(is deprecated)The standalone \mint openapi-check` command is deprecated.→Mintlify deprecated the standalone `mint openapi-check` command.`guides/assistant-embed.mdxMintlify.Will(avoidwill)## What you will build→## What you buildguides/branches.mdxMintlify.Passive(is created,are made,is merged)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.mdxline 4 —Use 'JSON' instead of 'json'. The match is inside theopenapi: /analytics.openapi.jsonfilename reference in frontmatter, not prose.api/analytics/feedback-by-page.mdxline 4 — same as above.api/preview/trigger.mdxline 4 —Use 'JSON' instead of 'json'. Filename inopenapi:frontmatter.cli/commands.mdxline 3, 90 —Use 'Dev' instead of 'dev'. Matches the command namemint dev/# Disable telemetrycode contexts.cli/commands.mdxlines 144, 160 —'\```' should use sentence-style capitalization`. Vale parsed code-fence markers as headings.cli/commands.mdxline 178 —Use 'subcommands?' instead of 'Subcommand'.Subcommandis a table column header.cli/commands.mdxline 367 —Did you really mean 'informat'?. Misparse of the wordinformation.agent/workflows.mdxhistorical 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.mdxlines 67, 171 —Use 'preceding' instead of 'above'.aboveis used spatially (displayed above the navbar,displayed above a page title), not referentially.customize/custom-scripts.mdxlines 82, 87, 170, 217 —Did you really mean 'Scrollable'/'targetable'?. Both are real English words used correctly in component descriptions.customize/custom-scripts.mdxlines 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.mdxline 136 —Passive ('is selected')inTooltip that appears when text is selected on a page.— the state is the subject; rewording changes meaning.editor/keyboard-shortcuts.mdxlines 96–98 —Use 'Cursor' instead of 'cursor'. The word refers to the text cursor, not the Cursor product.editor/keyboard-shortcuts.mdxline 97 —Use 'preceding' instead of 'above'. Refers to the spatial direction (Add cursor above).editor/pages.mdxline 58 —Use 'Mermaid' instead of 'mermaid'. The match is inside<kbd>/mermaid</kbd>, a command identifier.editor/pages.mdxline 62 —Use 'Cursor' instead of 'cursor'. Refers to the text cursor.editor/pages.mdxline 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.mdxline 103 —Use 'sidebars?' instead of 'Sidebar'.Sidebar titleis a UI settings label.guides/geo.mdxlines 8, 178–180 —Avoid first-person pronouns. Matches are inside quoted example questions users ask AI tools.guides/geo.mdxlines 21, 23 —Use 'backlinks?'/'scannable' instead. Matches are inside a table header/cell.guides/geo.mdxline 58 —don't use an ellipsis. Ellipsis is inside a fenced code block.guides/assistant-embed.mdxlines 76, 120, 121, 125 —Use semicolons judiciously. Semicolons are JavaScript statement terminators inside code blocks.guides/assistant-embed.mdxline 176 —Did you really mean 'handleSubmit'?. JavaScript identifier inside a code block.guides/developer-documentation.mdxline 145 — first-person pronouns in a quoted sample user question.guides/help-center.mdxline 182–184 — first-person pronouns in quoted sample user questions.guides/knowledge-base.mdxline 180 — first-person pronoun in a quoted sample user question.guides/internationalization.mdxlines 664, 666, 668 —Use 'PNG' instead of 'png'. Inside a file-tree code block.deploy/authentication-setup.mdxlines 107, 108, 140 —Use 'endpoints?'/'logouts?'.Endpoint/Logout URLare dashboard field labels.deploy/github.mdxlines 55, 129 —sentence-style capitalization.GitHub Appis a proper noun (GitHub product name).deploy/preview-deployments.mdxlines 46, 48, 51 —Use 'redeploy(s|ed|ing)?'. Sentence-start in heading/step list or UI button label.api/introduction.mdxline 9 —Use 'endpoints?' instead of 'Endpoints'. First word of a heading, correctly sentence-cased.Ambiguous – flagged for human review
cli/commands.mdxline 244 (theis deprecatedpassive). Fixed above, but alternate phrasings exist; reviewer may preferThe \mint openapi-check` command is no longer supported.` or similar.guides/internationalization.mdxlines 742, 746 —Passive ('be translated', 'are configured'). Rewording would require attributing an actor that the sentences deliberately omit.optimize/feedback.mdxline 84 —Passive ('has been resolved'). The sentence describes a feedback status label; rewording risks conflicting with the UI name of the status.deploy/github.mdxline 146 —Passive ('are disabled'). Describes UI state.deploy/preview-deployments.mdxline 17 —Passive ('are created'). Describes automatic behavior.api/preview/trigger.mdxline 18 —Passive ('are opened'). Describes CI pull-request event trigger.assistant/index.mdxline 8 —Passive ('is enabled'). Describes default state.agent/workflows.mdxline 164 —Did you really mean 'informat'?. Likely misparse; leaving unchanged.changelog.mdxAll
changelog.mdxwarnings reported against PR #5411 and #5431 were ignored —.vale.iniexplicitly disables Vale styles onchangelog.mdx(BasedOnStyles = ""), so these are not real CI failures.Validation
mint broken-links: no broken links found.mint validate: the pre-existing#.redirects: Invalid typeerror 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
croncasing in workflow trigger examples, rewrites a deprecation note incli/commands.mdxin active voice, adjusts a heading inguides/assistant-embed.mdx, and rephrases a sentence inguides/branches.mdxto 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.