Skip to content

Fix Vale style errors#3584

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771608257
Closed

Fix Vale style errors#3584
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771608257

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 20, 2026

Summary

  • Remove exclamation points from prose text (Vale error: Mintlify.Exclamation)
  • Remove space around em-dash (Vale error: Mintlify.EmDash)
  • Fix "open-source" to "open source" (Vale warning: Mintlify.WordList)

Files changed

  • migration-services/enterprise.mdx - Lines 16, 87
  • migration-services/pro.mdx - Line 90
  • deploy/authentication-setup.mdx - Line 50
  • changelog.mdx - Lines 1325, 1432

Issues requiring human judgment

The following Vale warnings were identified but require human review to determine if changes are appropriate:

Mintlify.Will (warning) - 68 occurrences

Use of "will" flagged across files. Consider rewriting to use present tense where appropriate:

File Line Current text Suggestion
ai/discord.mdx 35 "the bot will reply to messages" "the bot replies to messages"
api-playground/asyncapi-setup.mdx 98 "files will be placed" "files are placed"
api-playground/openapi-setup.mdx 431 "files will populate" "files populate"
components/banner.mdx 21 "API will be unavailable" Keep as-is (future event)
customize/custom-domain.mdx 71, 81 "provisioning will fail" Keep as-is (conditional)

Mintlify.Passive (suggestion) - Multiple occurrences

Passive voice detected. Consider rewriting to active voice:

File Line Example
Various Multiple "is enabled", "are configured", "was created"

Mintlify.WordList - "functionality" (warning) - 10 occurrences

Consider replacing "functionality" with "capability" or "feature":

File Line
changelog.mdx 156, 504, 683, 719, 805, 823, 932, 1313, 1350
components/color.mdx 3

Exclamation points in example/demo content (skipped)

These exclamation points appear in code examples, banners, or demo content and were intentionally left unchanged:

  • components/banner.mdx - Banner content examples
  • components/tabs.mdx - Demo tab content
  • create/reusable-snippets.mdx - Example snippet content
  • create/code.mdx - Code examples ("Hello, World!")
  • organize/settings.mdx - Banner configuration examples
  • quickstart.mdx - Screenshot alt text

Ellipses in code/UI examples (skipped)

Ellipses in code examples, spread operators, and UI references are intentional and were not changed.


Note

Low Risk
Documentation-only copy edits with no functional or behavioral code changes; risk is limited to minor wording/formatting regressions.

Overview
Fixes Vale lint/style violations across a handful of MDX docs pages by adjusting prose punctuation and wording.

This removes exclamation points, normalizes em-dash spacing, changes “open-source” to “open source”, and slightly tweaks a couple of list items (for example, “Launch!” → “Launch”) in changelog.mdx, deploy/authentication-setup.mdx, and the migration services docs.

Written by Cursor Bugbot for commit 2534977. This will update automatically on new commits. Configure here.

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