docs: align voice and tone with style guide#5841
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
Style consistency pass: remove "Please" filler and replace first-person plural ("we're going to…") with second-person/imperative voice in a handful of pages.
Changes
deploy/route53-cloudfront.mdx: rewrite three "we're going to / we're looking to" passages as imperative or second person; replace "in our case" with "for example" in two places.deploy/ghes.mdx: drop "Please" from the credential-sharing intro and the support-contact instructions.customize/custom-scripts.mdx: rewrite "Please use with caution to not introduce security vulnerabilities." as "Use with caution to avoid introducing security vulnerabilities."Context
Repo-wide scan for the style issues called out in
.cursor/rules/writing-standards.mdc(sentence-case headings, second person, active voice, no "Please" / filler). Most pages already follow the style guide — the remaining title-cased headings are proper nouns (GitHub, MCP, SEO, Tailwind, etc.),we/our/ususage is reserved for company-voice content (changelog, enterprise contracting, migration services, support), and click/select/choose are used consistently for their respective contexts. Only the deviations above were corrected.Note
Low Risk
Low risk documentation-only edits that adjust wording/tone without changing any product behavior or configuration steps.
Overview
Docs wording cleanup for style consistency. Updates several MDX guides to remove “Please” filler, shift phrasing from we/our to imperative/second-person voice, and replace a couple of “in our case” examples with “for example.”
Changes touch
customize/custom-scripts.mdx,deploy/ghes.mdx, anddeploy/route53-cloudfront.mdxonly, keeping the underlying instructions intact while standardizing tone and security warning language.Reviewed by Cursor Bugbot for commit d2fc94f. Bugbot is set up for automated code reviews on this repo. Configure here.