Skip to content

Fix writing style and tone consistency across docs#199

Merged
mintlify[bot] merged 1 commit intomainfrom
mintlify/style-consistency-1776644296
Apr 20, 2026
Merged

Fix writing style and tone consistency across docs#199
mintlify[bot] merged 1 commit intomainfrom
mintlify/style-consistency-1776644296

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 20, 2026

Summary

Audited all prose-heavy MDX pages and fixed style deviations to align with the established voice (second person, active voice, sentence case headings) used in newer pages.

Changes across 14 files

  • Voice: Replaced first person ("we"/"our"/"I") with second person ("you") or "Terminal49"
  • Typos: Fixed 12+ typos including freight, webhook, demonstrates, authorization, wherever, indicates, succeeded, terminal, and others
  • Grammar: Fixed its/it's errors, removed dangling sentence fragments
  • Headings: Converted title case headings to sentence case for consistency
  • Sentence length: Shortened overly long sentences (30+ words)
  • Tone: Removed informal language ("nifty", "getting your feet wet", "love Postman") in favor of professional, direct tone
  • Consistency: Standardized the JSON:API explanation note that appears across 3 getting-started pages

Pages updated

  • getting-started/start-here.mdx
  • getting-started/tracking-shipments-and-containers.mdx
  • getting-started/receive-status-updates.mdx
  • getting-started/list-shipments-and-containers.mdx
  • in-depth-guides/quickstart.mdx
  • in-depth-guides/webhooks.mdx
  • in-depth-guides/tracking-request-lifecycle.mdx
  • in-depth-guides/event-timestamps.mdx
  • in-depth-guides/terminal49-widget.mdx
  • in-depth-guides/terminal49-map.mdx
  • in-depth-guides/rail-integration-guide.mdx
  • in-depth-guides/rate-limiting.mdx
  • in-depth-guides/adding-customer.mdx
  • useful-info/tracking-request-retrying.mdx

Standardize voice, fix typos, and align older pages with the
established style guide (second person, active voice, sentence case
headings).

Changes across 14 files:
- Replace first person (we/our/I) with second person (you) or product
  name (Terminal49) for consistency with newer pages
- Fix typos: frieght→freight, neeed→need, demonstates→demonstrates,
  autorization→authorization, Wheverever→Wherever, indidicates→indicates,
  succeded→succeeded, teminal→terminal, webook→webhook, adn→and,
  pase→paste, wheter→whether
- Fix its/it's errors
- Convert title case headings to sentence case
- Shorten overly long sentences (30+ words)
- Remove informal language (nifty, getting your feet wet, love Postman)
- Standardize the JSON:API explanation note across 3 pages
- Fix passive voice where active voice is clearer

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

mintlify Bot commented Apr 20, 2026

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

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview Apr 20, 2026, 12:26 AM

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 20, 2026

Target branch is in the excluded branches list.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 20, 2026

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

Project Deployment Actions Updated (UTC)
api Building Building Preview, Comment Apr 20, 2026 0:26am

Request Review

@mintlify mintlify Bot merged commit ec7fdf9 into main Apr 20, 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