style: use active voice in technical statements#3904
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
style: use active voice in technical statements#3904mintlify[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
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)
guides/assistant-embed.mdxguides/automate-agent.mdxmigration-services/enterprise.mdxmigration-services/enterprise.mdxFirst-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:
Files:
components/banner.mdx,components/tabs.mdx,create/code.mdx,create/reusable-snippets.mdx,organize/navigation.mdx,organize/settings.mdxValidation
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. Inorganize/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.