docs: consistent Title Case for deployment and other page titles#1001
Merged
Conversation
Contributor
|
🔍 Mintlify preview for this branch: https://daily-pk-consistent-title-casing.mintlify.site |
kompfner
force-pushed
the
pk/consistent-title-casing
branch
from
July 18, 2026 01:14
e569f1f to
a82ce5e
Compare
kompfner
force-pushed
the
pk/consistent-title-casing
branch
from
July 18, 2026 01:21
a82ce5e to
1944e92
Compare
A consistency pass for the site's dominant AP-style Title Case convention
(210 of ~221 multi-word titles already follow it), covering two separate
things:
Page/sidebar titles that were still Sentence cased:
- Deployment (Pipecat tab): Running Bots Locally, Running Bots in Production,
VM per Session, Warm Pool with Subprocess Workers, Managed Agent Runtime,
Telephony in Production — plus the overview Card labels and the
"Production Hosting Patterns" group in docs.json.
- Callbacks and Events, Start/Stop an Agent Session, Reference Docs,
Health Checks.
Citation-style inline links whose text names a page but was under-
capitalized. Found via a whole-site sweep that resolved every internal link
to its target and compared the text to that page's title — largely
independent of the retitling above (agent-handoff and scaling link to pages
that were already correctly titled):
- overview "See [Running Bots in Production]" (plus the other deployment
See-directives and the next-page reference in running-bots-locally)
- agent-handoff "See [Agent Registry and Discovery]"
- scaling "See [Starting Sessions]"
Descriptive/woven references and idea enumerations are deliberately left in
prose case: the two-pattern enumeration in running-bots-in-production
("[vm per session] — ...", "[warm pool with subprocess workers] — ..."), the
"See also" tradeoff bullet, topic-label bullets ("WebSocket authentication"),
and woven mentions ("use context summarization", "when user mute strategies
activate", "the development runner handles ...").
Short prepositions/articles stay lowercase (in, of, to, with, an, per).
No link targets or URLs changed.
Claude-Session: https://claude.ai/code/session_01GnvjW9EYbxjKQz7K89gBhS
kompfner
force-pushed
the
pk/consistent-title-casing
branch
from
July 18, 2026 01:26
1944e92 to
edf1577
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A Title Case consistency pass across the docs, covering two separate things under the site's dominant AP-style Title Case convention:
Why
A scan of all 440 frontmatter titles found 210 of ~221 multi-word titles already use Title Case (e.g. "Speech to Text", "Building with Gemini Live", "Create an Agent"). Only 11 deviated with Sentence case — 6 of them in the Deployment section under the Pipecat tab, which is what prompted this — and a handful of links elsewhere hadn't kept up with their (already Title Case) targets.
Changes
1. Titles → Title Case (11 pages)
<Card>labels on the Deployment overview and the"Production Hosting Patterns"group header indocs.json(its sibling "Hosting Platforms" was already Title Case)2. Citation-style inline links → Title Case
A whole-site sweep resolved every internal link to its target page and compared the link text against that page's title. Only genuine page citations were changed — some point to pages retitled here, others to pages that were already correctly titled:
overview— "See [Running Bots in Production]" (plus the other deployment See-directives and the next-page reference inrunning-bots-locally) → targets retitled hereagent-handoff— "See [Agent Registry and Discovery]" → target already correctly titledscaling— "See [Starting Sessions]" → target already correctly titledLeft in prose case (deliberately)
Descriptive/woven references and idea enumerations, where the text names a concept rather than citing a page:
running-bots-in-production("[vm per session] — …", "[warm pool with subprocess workers] — …")warm-pool-subprocessNotes
🤖 Generated with Claude Code