Skip to content

Enforce style guide: fix voice, em-dashes, and heading case across docs - #315

Merged
mintlify[bot] merged 1 commit into
mainfrom
mintlify/47840be0
Aug 10, 2026
Merged

Enforce style guide: fix voice, em-dashes, and heading case across docs#315
mintlify[bot] merged 1 commit into
mainfrom
mintlify/47840be0

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Applies the site's predominant style (second-person, active voice, sentence-case in-body headings, no em-dash clause joiners) to 21 pages that drifted.

Changes

  • Split em-dash clause joiners into two sentences across MCP setup guides, webhook best practices, holds-and-fees, rail integration, tracking request lifecycle, MCP overview, terminal49-map, event-timestamps, and datasync overview.
  • Replaced first-person plural ("we", "our system") in auto-detect-carrier with "Terminal49" as the actor.
  • Converted passive constructions to active ("The digest is sent…" → "…and sends the digest…"; "the status field will not be changed" → "Terminal49 does not change the status field").
  • Rewrote third-person prose ("The most common issue people encounter…", "end-users may stop tracking…") into direct second-person.
  • Normalized terminology: "Choose events" → "Select events" in the receive-status-updates step; the stray "Please click…" in datasync/home.mdx uses "Select" to match the MCP setup guides.
  • Converted title-case accordion titles to sentence case in routing.mdx (12 accordions) and auto-detect-carrier.mdx (3 accordions), matching the sentence-case H2/H3 convention.

Context

Scheduled style-consistency audit over docs added in the past week. Frontmatter titles are intentionally title case across the repo and were left alone.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@mintlify

mintlify Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview Aug 10, 2026, 12:17 AM

@greptile-apps

greptile-apps Bot commented Aug 10, 2026

Copy link
Copy Markdown

PR author is in the excluded authors list.

@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api Building Building Preview Aug 10, 2026 12:16am

Request Review

@mintlify
mintlify Bot merged commit d02e107 into main Aug 10, 2026
10 of 11 checks passed
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