Skip to content

Enforce your style guide: voice and terminology consistency fixes - #330

Merged
jonoirwinrsa merged 3 commits into
masterfrom
mintlify/10e7eb54
Aug 26, 2026
Merged

Enforce your style guide: voice and terminology consistency fixes#330
jonoirwinrsa merged 3 commits into
masterfrom
mintlify/10e7eb54

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Style-only pass over pages touched by recent PRs (#321, #319, #327), fixing voice, terminology, and product-name consistency without changing technical content.

Changes

  • Replaced first-person drift ("let us", "our") with the imperative second-person voice used elsewhere (livekit-outbound-agent)
  • Rewrote awkward passives with a named actor: "it will be considered unhealthy... restarted should it not recover timely" → "Cerebrium considers the instance unhealthy and restarts it..." (custom-dockerfiles and custom-web-servers); "a machine is specified to stay running" → "you configure a machine to stay running" (calculating-cost); "When code is deployed" → "When you deploy code" (getting-started/introduction)
  • Split a run-on note into two sentences (realtime-voice-agents) and a 30+ word sentence (sglang example)
  • Normalized product-name casing: LiveKit, LangSmith, ComfyUI, Deepgram
  • Normalized phrasing: "Click on the" → "Click the" (custom-domains); "Navigate to Secrets tab" → "Navigate to the Secrets tab"; "the Deepgram Account Representative" → "your Deepgram Account Representative" (deepgram)

Context

Follow-up style scans of files changed in #321, #319, and #327. Headings already follow each page's existing convention; migrations/replicate.mdx and gpt-oss.mdx needed no changes. Code blocks and config untouched.

@mintlify
mintlify Bot requested review from kylegani and milo157 as code owners August 26, 2026 20:37
@mintlify

mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
cerebrium 🟢 Ready View Preview Aug 26, 2026, 8:38 PM

@jonoirwinrsa
jonoirwinrsa merged commit 137e1b5 into master Aug 26, 2026
2 checks passed
@jonoirwinrsa
jonoirwinrsa deleted the mintlify/10e7eb54 branch August 26, 2026 20:43
@mintlify

mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

Docs PR opened: #331

Rewrote the generic Deepgram and LangChain page titles into descriptive, SEO-friendly titles; all other audited metadata already passed.

Note: failed to automatically merge

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