Replace 'functionality' with preferred terms per Vale style guide#3624
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Replace 'functionality' with preferred terms per Vale style guide#3624mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
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
Ran Vale style audit on all MDX files (excluding
es/,fr/,zh/localization directories andchangelog.mdx). Fixed automatically-fixableMintlify.WordListviolations 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:
guides/knowledge-base.mdxapi-playground/openapi-setup.mdxapi-playground/openapi-setup.mdxapi-playground/openapi-setup.mdxapi-playground/mdx-setup.mdxapi-playground/troubleshooting.mdxdeploy/preview-deployments.mdxRecommendation: 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:
quickstart.mdxoptimize/pdf-exports.mdxguides/maintenance.mdxguides/geo.mdxRecommendation: 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.WordListstyle 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.