Skip to content

Match content to the style guide - #7528

Open
ethanpalm wants to merge 1 commit into
mainfrom
style-guide-cleanup
Open

ethanpalm wants to merge 1 commit into
mainfrom
style-guide-cleanup

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Sep 25, 2026 •

Copy link
Copy Markdown
Collaborator

Follow up to #7526

  • Replace spaced em dashes with commas, colons, or separate sentences.
  • Use sign in, signed in, and signed-out instead of log in variants.
  • Use preview deployment instead of preview link, and API playground in lowercase.

Term changes skip frontmatter keywords and the changelog. Localized snippets are unchanged.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Documentation-only wording and punctuation; no code, config, or product behavior changes.

Overview
This PR applies editorial updates across assistant skills, user-facing docs, changelog entries, and the setup-agent prompt so wording matches the Mintlify style guide (follow-up to prior style work).

Punctuation: Spaced em dashes are replaced with commas, colons, or separate sentences (including enterprise contracting step titles, robots.txt code block labels, and several changelog bullets). Changelog mint analytics subcommand lines use colons instead of em dashes.

Terminology: Sign in / signed in / signed-out replace log in variants in auth, CLI, assistant, personalization, OAuth help, and related pages. Preview deployment replaces preview link where previews are discussed. API playground is lowercased in prose and in the troubleshooting accordion title.

No behavior, APIs, or structural doc changes—copy and consistency only.

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

- Replace spaced em dashes with commas, colons, or separate sentences.
- Use sign in, signed in, and signed-out instead of log in variants.
- Use preview deployment instead of preview link, and API playground
  in lowercase.

Term changes skip frontmatter keywords and the changelog. Localized
snippets are unchanged.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 25, 2026, 11:59 PM

This branch was successfully deployed

1 active deployment
staging — f8c575fb Deployed Sep 25, 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