Skip to content

style: use active voice in technical statements#3904

Open
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-audit-1772251145
Open

style: use active voice in technical statements#3904
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-audit-1772251145

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 28, 2026

Summary

Vale style audit of 185 English MDX files from PR #3899. Fixed two instances where active voice improves clarity.

Automatic fixes applied

  • organize/settings.mdx:355: Changed "the build will fail" → "the build fails" (active voice, present tense)
  • deploy/ghes.mdx:233: Changed "The app will need to be re-approved by organization owners" → "Organization owners must re-approve the app" (active voice, clearer subject)

Items requiring human review

The following Vale warnings were found but require judgment to decide if changes are appropriate:

"will" usage (Mintlify.Will - warning)

File Line Text Suggested fix
guides/assistant-embed.mdx 8 "What you will build" Consider "What you build" or keep as-is (common tutorial heading pattern)
guides/automate-agent.mdx 8 "What you will build" Same as above
migration-services/enterprise.mdx 114 "we will implement it" Consider "we implement it" (but may sound less natural in FAQ context)
migration-services/enterprise.mdx 120 "our team will work with you" Consider "our team works with you" (but may sound less natural in FAQ context)

First-person pronouns in FAQ titles (Mintlify.FirstPerson - warning)

Multiple FAQ accordion titles use "I" (e.g., "How do I...", "Can I..."). These are appropriate for FAQ format and should not be changed.

Exclamation points (Mintlify.Exclamation - error)

All occurrences are in UI component examples or code blocks demonstrating realistic content. Not changed because:

  • They show users how components look with real content
  • Changing them would make examples less realistic

Files: components/banner.mdx, components/tabs.mdx, create/code.mdx, create/reusable-snippets.mdx, organize/navigation.mdx, organize/settings.mdx

Validation

  • Build validation passed
  • No broken links found

Note

Low Risk
Low risk documentation-only wording changes that don’t affect product behavior; main risk is minor meaning drift in instructions.

Overview
Updates two MDX docs to use clearer, more active phrasing.

In deploy/ghes.mdx, the FAQ instruction about permission updates now explicitly states that organization owners must re-approve the app. In organize/settings.mdx, the variables section wording is tightened from “will fail” to present tense (“build fails”).

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