Skip to content

docs: sentence case for headings and titles - #774

Open
hlenke wants to merge 6 commits into
mainfrom
docs/sentence-case-headings
Open

hlenke wants to merge 6 commits into
mainfrom
docs/sentence-case-headings

Conversation

@hlenke

@hlenke hlenke commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Requested by Hannes · project thread

Converts title-case headings and titles to sentence case. Only the first word and names keep a capital. Follow-up to #734.

What changed

1,819 lines in 363 .mdx files. Only letter case changed: every line has one deletion and one insertion, and lowercasing both gives the same text. No slugs, hrefs, links or anchors changed.

Covers Markdown headings, frontmatter title and sidebarTitle, and title props on <Tab>, <Card>, <Accordion> and <Step>.

The branch was rebuilt on current main: merging main conflicted in 55 files, so the case-only changes were reapplied to main's text. That also converted 9 title-case headings and titles added to main since.

Kept as is

  • Product and feature names (Playwright Check Suites, Agentic Checks, Rocky AI, Monitoring as Code, AI Assistant, Checkly Skills).
  • Check and monitor types keep the type word capitalized (Browser check, URL monitor).
  • Third-party product names, acronyms and mixed-case words.
  • Quoted text, inline code, <YoutubeEmbed> titles, api-reference/**, api-reference-old/** and docs.json.

How it was verified

Check Result
Casing lint from #775 on the changed lines 0 problems in 1,818 lines
Case-only diff every changed line matches its old line when lowercased
hrefs, links, inline code, anchors unchanged on every changed line
check-anchors every internal #fragment resolves

Not changed

  • docs.json navigation labels.
  • "Data Processing Addendum" (legal document name) and "the Alerts table" (UI name).
  • The Card title "Playwright Checks Suite": fixing it needs a wording change, not just casing.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WL5whrFpHCtRKygwuMxU8e

hlenke and others added 5 commits October 27, 2026 21:39
Applies the pattern from Laura's capitalization commits (c0043be, 2f3d950)
across the docs: capitalized check and monitor types with a lowercase noun
(Browser checks, Multistep checks, API checks, URL monitors), lowercase
feature nouns in prose (status page, private location, alert channel),
and vendor casing for third-party names (GitHub, TypeScript, PagerDuty,
OpenTelemetry, Opsgenie). Code, commands, identifiers, URLs and quoted UI
labels are unchanged.

DOC-238

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Resolve 12 conflicts in 10 files: keep main's content changes (removed sections,
new icons, rewritten sentences) and reapply the casing rules on top.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Convert the remaining title-case Markdown headings, frontmatter title and
sidebarTitle values, and Card/Step/Tab/Accordion title props to sentence
case. Letter case only: no rewording, slugs, hrefs or anchors changed.

Kept as is: product and feature names, check and monitor types
(Browser check, URL monitor), third-party names, acronyms, quoted text,
inline code, YoutubeEmbed titles and generated API reference pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rebuilt on current main instead of resolving 55 conflicting files by hand:
the case-only changes are reapplied to main's text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WL5whrFpHCtRKygwuMxU8e
@hlenke
hlenke changed the base branch from docs-audit/doc-238-casing-consistency to main November 17, 2026 22:39
@mintlify

mintlify Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 17, 2026, 10:40 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@hlenke
hlenke marked this pull request as ready for review November 17, 2026 22:40

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ready to merge · Every one of the 1,819 changed lines differs from its old line only in letter case, and CI is green. Three optional wording fixes are inline, where a third-party feature name was lowercased. Land this before the open PRs that touch the same files.

Overlap. This PR touches files that 11 other open PRs also edit: #849 (detect/overview.mdx, platform/views.mdx), #598 and #571 (custom-roles.mdx, managing-team-members.mdx), #416 (constructs/api-check.mdx, api-checks/configuration.mdx), #855 (cli/checkly-import.mdx), #854 (communicate/alerts/channels.mdx), #851 and #830 (platform/private-locations/change-log.mdx), #847 and #830 (platform/variables.mdx), #847 (integrations/alerts/webhooks.mdx), and #595 (playwright-reporter-changelog.mdx). It's MERGEABLE/CLEAN now, but the last rebuild already had to reapply 55 conflicting files. Merging it first leaves the others with small, case-only conflicts. Merging it last means another rebuild.

Since the merge base. main gained one commit, c6fb6612 (#852). It edits a body line in ai/skills.mdx and one in guides/agentic-workflows.mdx, not the headings this PR changes. GitHub reports no conflict.

Consistency to decide (not blocking). MCP Server and Playwright Reporter are mixed-case on main, and this PR lowercases them only in titles:

  • Checkly MCP Server becomes Checkly MCP server in 3 page titles and 2 Card titles. The docs.json nav group stays MCP Server, because docs.json is out of scope. #852, merged today, links to it as "Checkly MCP Server". main's body text uses "MCP Server" in 13 files and "MCP server" in 12.
  • Playwright Reporter becomes Playwright reporter in the page title, the sidebar title, the install heading, the changelog title, and the changelog Card. The descriptions next to them still say "the Checkly Playwright Reporter".

If these are product names, add them to the list you kept (Rocky AI, Monitoring as Code, …) and to styles/Checkly/proper-nouns.txt in #775. If they're generic nouns, a follow-up should lowercase the body text and the nav label to match. The casing check passes either way.

Inline: 3 Wording (optional).

What I checked
  • Merge base 15169559 with origin/main. git diff --shortstat: 363 files, 1,819 insertions and 1,819 deletions.
  • Wrote a script (in the run directory, not from the PR) that pairs every -/+ line in git diff --unified=0 and compares them lowercased. All 1,819 pairs match, every hunk has as many removed lines as added, and nothing else changed: no href, slug, code, or wording change.
  • Listed every word that went from upper to lower case (933 distinct) and reviewed the changed lines that contain product, feature, UI, and third-party names (MCP Server, Playwright Reporter, Rocky AI, Monitoring as Code, Playwright Check Suite, Agentic Check, OpenTelemetry/Collector, Kubernetes, Node Problem Detector, Pulumi, Vercel, GitLab, Slack, Microsoft Teams, Web Vitals, OTTL, and others). Product names and third-party product names are kept as the PR description says, except the three inline items.
  • Anchors: Mintlify builds heading slugs in lower case, so case-only heading changes keep every #fragment. python3 scripts/pr_impact.py reported no broken anchors or removed pages, only informational hub notes.
  • gh pr checks 774: static-docs-checks (including the anchor check), docs-gate, preview-checks, link-rot, vale-spellcheck, and Mintlify Deployment pass.
  • gh pr view 774: MERGEABLE, CLEAN. git log 15169559..origin/main: only c6fb6612.
  • Overlap: gh pr list --json number,files, then git diff --name-only on the shared paths.
  • Release-bot changelog syncs (#576, #595) only insert <Update> blocks and don't rewrite the title, so the new playwright-reporter-changelog.mdx title should survive future syncs.
  • git grep on origin/main for the casing of MCP Server and Playwright Reporter, and for the OTTL and Vercel names in the pages' own body text.
  • No end-to-end tests: the PR changes only letter case, with no product behavior.

title: Vercel Deployment Protection
description: "Let Checkly's Browser checks reach protected Vercel preview and production deployments by passing a Protection Bypass for Automation secret in your tests."
sidebarTitle: Deployment Protection
sidebarTitle: Deployment protection

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Wording (optional): "Deployment Protection" is Vercel's feature name. The page's own title (line 2) keeps it as "Vercel Deployment Protection", and line 9 says "Vercel calls this Deployment Protection". Keep the sidebar title the same:

Suggested change
sidebarTitle: Deployment protection
sidebarTitle: Deployment Protection

```

## Vercel Authentication
## Vercel authentication

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Wording (optional): "Vercel Authentication" is the name of Vercel's protection method, and the link below points to Vercel's #vercel-authentication section. "Standard Protection" on line 61 also kept its capitals.

Suggested change
## Vercel authentication
## Vercel Authentication

---

## Transformations Using OpenTelemetry Transform Language (OTTL)
## Transformations using OpenTelemetry transform language (OTTL)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Wording (optional): OTTL is a proper name. The description (line 4) and the first sentence under this heading (line 57) both write "OpenTelemetry Transform Language".

Suggested change
## Transformations using OpenTelemetry transform language (OTTL)
## Transformations using OpenTelemetry Transform Language (OTTL)

This branch was successfully deployed

1 active deployment
staging — fc478078 Deployed Nov 17, 2026 by mintlify[bot]
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