Skip to content

Apply brand tone and writing style fixes - #7539

Merged
ethanpalm merged 10 commits into
mainfrom
mintlify/77115157
Sep 28, 2026
Merged

ethanpalm merged 10 commits into
mainfrom
mintlify/77115157

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Style review of pages changed in #7531, #7536, #7537, and #7540, plus heuristic passes over all English MDX pages.

Changes

  • desktop.mdx: Replaced "login" with "sign-in" in the beta note to match the page's "sign in" terminology. The UI labels stay as they are.
  • es/cli/preview.mdx: Replaced "vista previa local" with "previsualización local" to match the rest of the page. The leftover English "assistant" in the description was fixed separately on main in Fix grammar & typos: untranslated word in es CLI preview #7541.
  • fr/guides/geo.mdx: Changed the heading "Autoriser les agents IA dans robots.txt" to the imperative "Autorisez" to match sibling headings. Also fixed an ungrammatical closing clause ("plutôt qu'une défaillance de l'IA").
  • cli/index.mdx: Changed "Log in to enable search" to "Sign in", matching the cli/preview.mdx heading.
  • assistant/configure.mdx, editor/pages.mdx, guides/branches.mdx: Changed "choose UI option" to "select UI option". The docs use "select" for UI options about 47 times and "choose" 4 times.
  • cli/mdx-extension.mdx: Split two long sentences (40 and 46 words).
  • deploy/deployments.mdx, help-center/agent-opens-pull-requests-against-deploy-branch.mdx, help-center/branch-missing-from-editor-branch-list.mdx: Split sentences of 35 or more words into two.
  • help-center/site-search-returns-no-results.mdx: Rewrote a passive clause as active ("a hidden setting ... likely excludes your pages").

Not changed

  • First-person "we"/"our" on support and legal pages (advanced-support.mdx, enterprise-contracting.mdx, deploy/ghes.mdx, contact-support.mdx). This looks like an intentional Mintlify voice.
  • Title-case headings the scan flagged. They are product names or third-party UI labels, such as "Advanced Slack Support" and "Attributes & Claims".
  • deploy/github.mdx: "choose Only select repositories". Changing it to "select" would read awkwardly.
  • Long list items, such as file-type or endpoint lists, and about 30 sentences of 31 to 34 words. Splitting these would not clearly help.

Note

Low Risk
Documentation-only copy edits with no runtime, API, or configuration behavior changes.

Overview
Applies brand tone and writing-style fixes across English, Spanish, and French MDX docs—no product or code changes.

Terminology: Replaces choose with select for dashboard/UI actions (assistant/configure, editor/pages, guides/branches). Aligns sign in wording in cli/index and desktop (beta note uses “sign-in” instead of “login”). Spanish es/cli/preview standardizes on previsualización local instead of “vista previa local”. French fr/guides/geo uses imperative Autorisez for a heading and fixes an awkward closing clause.

Readability: Splits long sentences in cli/mdx-extension, deploy/deployments, and several help-center articles. Rewrites one passive troubleshooting lead in site-search-returns-no-results to active voice.

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

@mintlify

mintlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 28, 2026, 4:37 PM

@ethanpalm
ethanpalm merged commit 1ca1756 into main Sep 28, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the mintlify/77115157 branch September 28, 2026 17:14

This branch was successfully deployed

1 active deployment
staging — 78a4abe0 Deployed Sep 28, 2026 by mintlify[bot]
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