Skip to content

Fix Vale style warnings from recent merged PRs#5247

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/vale-warnings-1775758405
Open

Fix Vale style warnings from recent merged PRs#5247
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/vale-warnings-1775758405

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 9, 2026

Summary

Fixes Vale style warnings identified across merged PRs from the past week (#5150, #5152, #5192, #5198, #5213).

Changes (11 files)

  • Passive voice → active voice in agent/workflows.mdx, api-playground/troubleshooting.mdx, cli/commands.mdx, cli/preview.mdx, components/fields.mdx, components/responses.mdx, deploy/ci.mdx, guides/configure-automerge.mdx, organize/navigation.mdx, status.mdx
  • Word choice: abovepreceding in components/tooltips.mdx
  • Capitalization: Subcommandsubcommand in cli/commands.mdx table header

Warnings noted as false positives (not fixed)

These warnings appear in CI but are false positives or cannot be fixed without changing meaning:

Warning File Reason
'informat' spelling agent/workflows.mdx:76, cli/commands.mdx:330 Vale incorrectly splits "information" at a line boundary in rendered output
'substring' spelling cli/analytics.mdx:44, cli/commands.mdx:108 Already in Vale vocabulary (accept.txt)
'````' sentence-style capitalization cli/commands.mdx:144,160 False positive on markdown code fence syntax
'subcommands' spelling cli/commands.mdx:75 Already in Vale vocabulary
'Strikethrough'/'strikethrough' create/text.mdx:73,81,82 Already in Vale vocabulary
'blockquotes' create/text.mdx:3 Already in Vale vocabulary
'LLMs' optimize/analytics.mdx:88 Already in Vale vocabulary
'Quickstart' quickstart.mdx:2 Already in Vale vocabulary, used as page title
'OAS' guides/migrating-from-mdx.mdx:3 Already in Vale vocabulary, used in sidebar title
'Nginx' deploy/docs-subpath.mdx:3 Already in Vale vocabulary as nginx
'Rulesets' guides/configure-automerge.mdx:26,27 Refers to GitHub UI navigation label, already in vocabulary
'Dropdowns'/'Breadcrumbs' organize/navigation.mdx:383,385,953,955 Section headings, already in vocabulary
Oxford comma in conditional clauses agent/workflows.mdx:216,218 Vale misparses "If you create..., edit or delete" as a list; it's a conditional clause with two verbs
'structure' sentence-style cap ai/skillmd.mdx:49 Heading starts with code span; lowercase after code span is correct sentence case

Scope

  • Only English-language files edited
  • No content meaning changed—style corrections only

Note

Low Risk
Low risk documentation-only edits that primarily rephrase sentences for style (active voice/wording) and adjust minor formatting; no functional or behavioral changes.

Overview
Resolves Vale prose-lint warnings across multiple MDX docs by rephrasing sentences (mostly passive→active voice) and tightening wording for clarity.

Includes a couple of small consistency tweaks, such as table header capitalization in cli/commands.mdx and minor wording adjustments in component/property descriptions and CI/Vale guidance.

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

Convert passive voice to active voice, fix sentence-style capitalization,
and update word choice per Vale linter suggestions.

Generated-By: mintlify-agent
@mintlify-development
Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
userauth 🟡 Building Apr 9, 2026, 6:18 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 9, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 9, 2026, 6:21 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.

0 participants