Skip to content

Comments

Fix Vale style violations: replace 'functionality'#3672

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

Fix Vale style violations: replace 'functionality'#3672
mintlify[bot] wants to merge 1 commit intomainfrom
vale-fixes-1771889530

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 23, 2026

Summary

This PR fixes Vale style violations by replacing instances of 'functionality' with more concise and preferred alternatives per the Mintlify WordList style rule.

Changes made (auto-fixed)

  • components/color.mdx: Changed description to 'click-to-copy'
  • deploy/ghes.mdx: Changed to 'may affect how the app works'
  • deploy/route53-cloudfront.mdx: Changed to 'connect the...to'
  • guides/content-templates.mdx: Changed to "product's features"
  • guides/content-types.mdx: Changed to "product's features"
  • guides/linking.mdx: Changed to 'advanced features'
  • installation.mdx: Changed to 'appearance and features'
  • migration-services/enterprise.mdx: Changed to 'search'
  • migration-services/pro.mdx: Changed to 'search'
  • migration.mdx: Changed to 'Search works'

Issues requiring human judgment

'will' usage (warning level - 50+ instances)

File Line Context
ai/contextual-menu.mdx 90 We will replace the following placeholders...
ai/discord.mdx 35 ...the bot will reply to messages...
api-playground/asyncapi-setup.mdx 98 ...files will be placed in...
api-playground/openapi-setup.mdx 431 ...files will populate in...
deploy/ci.mdx 27-28 ...check will never/will provide...
deploy/cloudflare.mdx 40,124,127 Future behavior descriptions
deploy/preview-deployments.mdx 11 ...changes to your docs will look...
guides/auth0.mdx 13,49 ...users will be able to log in...
guides/automate-agent.mdx 8,56,225 Tutorial future tense
And ~40 more

'functionality' in changelog entries (skipped)

changelog.mdx lines: 20, 181, 529, 708, 744, 830, 848, 957, 1338, 1375

Validation

  • mint validate passes
  • mint broken-links passes

Note

Low Risk
Documentation-only wording edits with no runtime or API changes; risk is limited to minor phrasing/clarity regressions.

Overview
Docs-only cleanup to satisfy Vale style rules by replacing the word “functionality” with shorter alternatives (mostly “features”, “works”, or simplifying phrasing) across several MDX guides.

Also makes a few small wording tweaks (e.g., “click-to-copy”, Route53/CloudFront phrasing, and simplifying search-related checklist items) with no behavioral changes.

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