Skip to content

docs: consistent Title Case for deployment and other page titles#1001

Merged
kompfner merged 1 commit into
mainfrom
pk/consistent-title-casing
Jul 18, 2026
Merged

docs: consistent Title Case for deployment and other page titles#1001
kompfner merged 1 commit into
mainfrom
pk/consistent-title-casing

Conversation

@kompfner

@kompfner kompfner commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

What

A Title Case consistency pass across the docs, covering two separate things under the site's dominant AP-style Title Case convention:

  1. Page/sidebar titles that were still Sentence cased.
  2. Citation-style inline links whose text names a page but was under-capitalized — found via a whole-site sweep, and largely independent of (1): most of the linked pages were already correctly titled.

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)

  • 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 matching <Card> labels on the Deployment overview and the "Production Hosting Patterns" group header in docs.json (its sibling "Hosting Platforms" was already Title Case)
  • Five other site-wide deviators: Callbacks and Events · Start an Agent Session · Stop an Agent Session · Reference Docs · Health Checks

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 in running-bots-locally) → targets retitled here
  • agent-handoff — "See [Agent Registry and Discovery]" → target already correctly titled
  • scaling — "See [Starting Sessions]" → target already correctly titled

Left in prose case (deliberately)

Descriptive/woven references and idea enumerations, where the text names a concept rather than citing a page:

  • the two-pattern enumeration in running-bots-in-production ("[vm per session] — …", "[warm pool with subprocess workers] — …")
  • the "## See also" tradeoff bullet in warm-pool-subprocess
  • topic-label bullets ("WebSocket authentication" beside "Regional endpoints"; "Twilio WebSocket integration" beside "Daily PSTN integration")
  • woven mentions ("use context summarization", "when user mute strategies activate", "the development runner handles…")

Notes

  • Short prepositions/articles stay lowercase (in, of, to, with, an, per), consistent with existing titles.
  • No URLs or link targets changed, so no links break.
  • Single squashed commit.

🤖 Generated with Claude Code

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-pk-consistent-title-casing.mintlify.site

@markbackman markbackman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹

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
kompfner force-pushed the pk/consistent-title-casing branch from 1944e92 to edf1577 Compare July 18, 2026 01:26
@kompfner
kompfner merged commit bbcae21 into main Jul 18, 2026
3 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.

2 participants