Skip to content

Comments

Fix Vale style errors#3622

Merged
ethanpalm merged 1 commit intomainfrom
vale-fixes-1771636656
Feb 23, 2026
Merged

Fix Vale style errors#3622
ethanpalm merged 1 commit intomainfrom
vale-fixes-1771636656

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 21, 2026

Summary

  • Fixed AMPM format error: 9AM-5PM9 AM-5 PM
  • Fixed hyphenated adverb errors: manually-writtenmanually written, currently-installedcurrently installed

Files Changed

  • advanced-support.mdx (line 33): Fixed time format
  • api-playground/overview.mdx (line 135): Fixed hyphenated adverb
  • installation.mdx (line 265): Fixed hyphenated adverb
  • organize/settings.mdx (line 836): Fixed hyphenated adverb

Issues Requiring Human Judgment

The following Vale warnings were identified but require manual review since they appear in code examples, component attributes, or intentional content:

Exclamation Points (ERROR level, but in example content)

These exclamation points appear in demo/example content where they're intentional:

File Line Content
components/banner.mdx 14, 59, 72 Banner example: "🚀 Version 2.0 is now live!"
components/tabs.mdx 25, 49 Tab example: "This one has a leaf icon!"
create/code.mdx 414, 424 Code example: "Hello, World!"
create/reusable-snippets.mdx 35 Snippet example: "Hello world!"
organize/navigation.mdx 574, 587 Navigation banner examples
organize/settings.mdx 625 Settings banner example

Recommendation: Keep as-is. These are example content demonstrating component usage.

Ellipses (WARNING level, in code/JSON examples)

These ellipses are intentional truncation indicators in code examples:

File Lines Context
api-playground/adding-sdk-examples.mdx 29 # ... in code
api-playground/complex-data-types.mdx 36, 71, 78 # ... in code
api-playground/managing-page-visibility.mdx 43-60 /*...*/ in JSON
api-playground/troubleshooting.mdx 49 get: ... in YAML
create/code.mdx 397 # ... in code
customize/fonts.mdx 37 Directory tree
deploy/ci.mdx 70-79 Vale config examples
guides/internationalization.mdx 112-136 [...] in JSON
snippets/icons-optional.mdx 15-16 Code examples

Recommendation: Keep as-is. Ellipses are standard for indicating truncated code.

WordList "filename" (WARNING level, in component attributes)

The name="filename" pattern appears in <Tree.File> and <ResponseField> components - these are attribute names, not prose:

File Lines
components/tree.mdx 13-81 (multiple <Tree.File name=...> elements)
create/code.mdx 484-527 (filename prop documentation)
index.mdx 8-68 (filename variable in HeroCard component)

Recommendation: Keep as-is. These are code attributes, not prose.

WordList "functionality" (WARNING level)

These uses of "functionality" are appropriate in context:

File Line Context
components/color.mdx 3 "click-to-copy functionality" - accurate description
deploy/ghes.mdx 234 "may affect functionality" - accurate
deploy/route53-cloudfront.mdx 177 "functionality of the CloudFront distribution"
guides/content-templates.mdx 179 "product's functionality"
guides/content-types.mdx 62 "product's functionality"
installation.mdx 18 "test your documentation site's appearance and functionality"

Recommendation: Consider replacing with "feature" or "capability" where it reads better, but these are borderline and functional.


Note

Low Risk
Documentation-only wording changes with no impact to runtime code or configuration semantics.

Overview
Cleans up MDX docs copy to resolve Vale style errors.

Updates advanced-support.mdx to use spaced AM/PM formatting (9 AM-5 PM), and removes hyphenation in a few phrases (e.g., “manually written”, “currently installed”) in API playground and installation/docs settings pages.

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

@ethanpalm ethanpalm merged commit 4090add into main Feb 23, 2026
5 checks passed
@ethanpalm ethanpalm deleted the vale-fixes-1771636656 branch February 23, 2026 18:38
mintlify bot added a commit that referenced this pull request Feb 23, 2026
Syncs style changes from PR #3622 to Spanish, French, and Chinese translations:
- AM/PM format with proper spacing (9 AM - 5 PM)
- Remove hyphen from 'manually written' compound adjective

Generated-By: mintlify-agent
ethanpalm added a commit that referenced this pull request Feb 23, 2026
Syncs style changes from PR #3622 to Spanish, French, and Chinese translations:
- AM/PM format with proper spacing (9 AM - 5 PM)
- Remove hyphen from 'manually written' compound adjective

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
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