Skip to content

Comments

Replace 'functionality' with preferred terms per Vale style guide#3624

Open
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771637051
Open

Replace 'functionality' with preferred terms per Vale style guide#3624
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fixes-1771637051

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 21, 2026

Summary

Ran Vale style audit on all MDX files (excluding es/, fr/, zh/ localization directories and changelog.mdx). Fixed automatically-fixable Mintlify.WordList violations by replacing "functionality" with clearer alternatives.

Files changed (11 files)

  • components/color.mdx - "click-to-copy functionality" → "click-to-copy"
  • deploy/ghes.mdx - "affect functionality" → "affect features"
  • deploy/route53-cloudfront.mdx - "functionality of the CloudFront distribution" → "CloudFront distribution"
  • guides/content-templates.mdx - "product's functionality" → "product's features"
  • guides/content-types.mdx - "product's functionality" → "product's features"
  • guides/cursor.mdx - "import functionality" → "import"
  • guides/linking.mdx - "advanced functionality" → "advanced features"
  • installation.mdx - "appearance and functionality" → "appearance and features"
  • migration-services/enterprise.mdx - "search functionality" → "search"
  • migration-services/pro.mdx - "search functionality" → "search"
  • migration.mdx - "Search functionality works" → "Search works"

Issues requiring human judgment

The following style violations were identified but require human review due to context-specific considerations:

1. "file path" vs "path" (WordList rule - warning)

The Vale style guide recommends using "path" instead of "file path". However, these instances may benefit from the explicit "file path" term for clarity in technical documentation:

File Line Current text
guides/knowledge-base.mdx 132 "The file path must match the path in your docs.json"
api-playground/openapi-setup.mdx 242 "accepts either a file path in your docs repo or a URL"
api-playground/openapi-setup.mdx 368 "by including the file path"
api-playground/openapi-setup.mdx 420 "include the file path in your reference"
api-playground/mdx-setup.mdx 133 "by including the OpenAPI file path and the endpoint"
api-playground/troubleshooting.mdx 107 "will be treated as file paths"
deploy/preview-deployments.mdx 87 "Missing or incorrect file paths"

Recommendation: Consider keeping "file path" in contexts where distinguishing between file paths and URL paths is important.

2. "will" usage (Will rule - warning)

Multiple instances of "will" for future tense found across documentation. These are stylistic and the present tense alternatives may not always improve clarity:

File Line Example
quickstart.mdx 162 "preview how your pages will look"
optimize/pdf-exports.mdx 20 "The PDF will contain all the content"
guides/maintenance.mdx 38 "Users will appreciate having less information"
guides/geo.mdx 28 "you will be well on your way"

Recommendation: Review on a case-by-case basis; many uses are appropriate for describing future states or outcomes.

3. Exclamation marks in example content (Exclamation rule - error)

Found exclamation marks in JSON code examples and banner content (e.g., "Version 2.0 is now live!"). These are intentional examples showing banner configuration, not prose violations.

No action needed - exclamation marks in example content are appropriate.


Note

Low Risk
Pure documentation wording edits (mostly replacing “functionality” with “features” or removing it) with no behavioral or configuration changes.

Overview
Updates docs copy across multiple MDX pages to align with the Vale Mintlify.WordList style rule by replacing “functionality” with preferred alternatives (primarily “features”) or shortening phrases (e.g., “search functionality” → “search”).

Changes are limited to wording in component docs (components/color.mdx), deployment guides (deploy/*), writing guides (guides/*), installation instructions (installation.mdx), and migration checklists (migration*.mdx).

Written by Cursor Bugbot for commit 2bbc1f3. 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.

0 participants