Skip to content

Standardize style and tone across docs#5652

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/style-consistency-1777695921
Open

Standardize style and tone across docs#5652
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/style-consistency-1777695921

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 2, 2026

Audits English MDX pages against the project's Style and tone guide and fixes the highest-confidence deviations.

Changes

  • Terminology: replaced "Click" with "Select" across 21 files for Mintlify-owned UI actions, per the style guide's terminology rules. Third-party UI instructions (Auth0, GitHub, GitLab, Vercel, Google Analytics) were left alone to mirror those products' own labels.
  • Long sentences split for readability (each was 35+ words) in ai/contextual-menu.mdx, api-playground/managing-page-visibility.mdx, guides/custom-frontend.mdx, dashboard/permissions.mdx, optimize/feedback.mdx, and editor/pages.mdx.

Not changed

  • Headings — all ## Title Case candidates contain proper nouns (React, Git, OpenAPI, etc.) and are valid sentence case.
  • Filler phrases — none found outside guides/style-and-tone.mdx (where they appear as anti-examples).
  • Third-person "Users can…" — remaining instances refer to end-users of the reader's published docs, where third person is appropriate.
  • Code samples, frontmatter, and API references were left untouched.

Note

Low Risk
Documentation-only wording edits (primarily "Click"→"Select" and minor sentence rewrites) with no behavioral, API, or configuration changes.

Overview
Standardizes docs wording to match the style guide by consistently using "Select" (instead of "Click") for Mintlify UI actions across multiple guides (editor, workflows, previews, assistant, MCP, etc.).

Also improves readability by restructuring a handful of long sentences and tightening phrasing in a few pages (e.g., contextual menu, OpenAPI page visibility, headless/custom frontend, permissions, feedback, and editor pages).

Reviewed by Cursor Bugbot for commit a5a8ec6. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 2, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 2, 2026, 5:15 AM

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