Skip to content

Fix Vale style issues from PR 3883#3892

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

Fix Vale style issues from PR 3883#3892
mintlify[bot] wants to merge 1 commit intomainfrom
vale-fixes-1772244357

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 28, 2026

Summary

Fixes Vale style violations identified in files modified by PR #3883.

Auto-fixed issues

Mintlify.Will (warning) - Removed use of "will" to favor present tense:

  • agent/index.mdx:11 - Changed "the agent:" to "the agent does the following:"
  • ai-native.mdx:8 - Changed "to improve" to "that improve"
  • ai-native.mdx:14 - Changed "helps guide" to "guides"
  • ai-native.mdx:26 - Changed "which helps" to "helping"
  • dashboard/audit-logs.mdx:65 - Changed "when the export is ready" to "when the export is complete"
  • guides/knowledge-base.mdx:8 - Changed "giving your team" to "gives your team"

Mintlify.OxfordComma (warning) - Added missing Oxford comma:

  • guides/knowledge-base.mdx:37 - Changed "like dates, authors, and tags" to "such as dates, authors, and tags"

Clarity improvements:

  • guides/knowledge-base.mdx:100 - Reworded "set up only authentication" to "set up authentication only"
  • guides/knowledge-base.mdx:102 - Changed "to specific users" to "for specific users"

Issues requiring human review

The following issues were identified but may require human judgment to fix appropriately:

File Line Rule Issue Suggestion
guides/knowledge-base.mdx 239 Mintlify.Passive "Content becomes stale over time" Passive voice - consider "Content grows stale over time"
ai-native.mdx 28 Mintlify.Passive "LLMs respond efficiently with relevant information" Could be more active but meaning is clear
Multiple files Various Mintlify.Passive Various passive constructions Many are intentional (e.g., "is available", "is automatically enabled") and changing would alter meaning

Note

Low Risk
Low risk: documentation-only wording tweaks to satisfy Vale style rules; no product behavior or API changes.

Overview
Resolves Vale style violations across several .mdx docs by rewriting future tense/"will" phrasing into present tense and making minor clarity edits.

Updates include small copy changes in agent/index.mdx, ai-native.mdx, dashboard/audit-logs.mdx, and guides/knowledge-base.mdx (including adding an Oxford comma and rewording a couple of authentication-related sentences) without changing meaning or structure.

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

Generated-By: mintlify-agent
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