Skip to content

Fix style consistency issues across docs#5694

Merged
ethanpalm merged 2 commits intomainfrom
mintlify/style-consistency-1778171536
May 7, 2026
Merged

Fix style consistency issues across docs#5694
ethanpalm merged 2 commits intomainfrom
mintlify/style-consistency-1778171536

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 7, 2026

Summary

Standardizes voice, tone, and UI verb usage across English MDX pages to match the predominant Mintlify style.

Changes

  • Standardize UI verbs to "select" — Removed inconsistent mixing of click/choose/select within the same instruction. The convention is to use select for UI element interactions (#5641 previously established this pattern).
    • ai/mintlify-mcp.mdx
    • ai/model-context-protocol.mdx
    • deploy/ci.mdx
    • deploy/github.mdx
    • deploy/gitlab.mdx
    • guides/auth0.mdx
    • status.mdx
  • Remove filler word "please" in directives, replacing with direct imperative voice.
    • contact-support.mdx
    • guides/auth0.mdx
  • Trim trailing whitespace in ## Implementation heading.
    • api-playground/managing-page-visibility.mdx
  • Subject/verb agreement fix: "results lists" → "results list".
    • deploy/ci.mdx

No technical content, code samples, or API references were changed.


Note

Low Risk
Documentation-only wording tweaks to standardize UI verb usage and improve grammar; no code, APIs, or behavior changes.

Overview
Standardizes instructional wording across several docs pages by making UI actions more consistent (e.g., clarifying multi-step interactions like "select … then select" / separating combined actions) and tightening imperative voice.

Also includes small copy edits for correctness and consistency (fixing a heading whitespace issue and a subject/verb agreement typo) in pages like deploy/ci.mdx, deploy/github.mdx, deploy/gitlab.mdx, and related AI/Auth0 guides.

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

Generated-By: mintlify-agent
@mintlify-development
Copy link
Copy Markdown
Contributor

mintlify-development Bot commented May 7, 2026

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

Project Status Preview Updated (UTC)
userauth 🟢 Ready View Preview May 7, 2026, 5:11 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 7, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 7, 2026, 4:37 PM

Comment thread ai/model-context-protocol.mdx Outdated
Comment thread deploy/ci.mdx Outdated
Comment thread deploy/github.mdx Outdated
Comment thread deploy/github.mdx Outdated
Comment thread deploy/gitlab.mdx Outdated
Comment thread guides/auth0.mdx Outdated
Comment thread status.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm ethanpalm merged commit 2731b04 into main May 7, 2026
4 of 6 checks passed
@ethanpalm ethanpalm deleted the mintlify/style-consistency-1778171536 branch May 7, 2026 21:12
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.

2 participants