Skip to content

Make casing of check types, features and brand names consistent - #734

Draft
hlenke wants to merge 2 commits into
mainfrom
docs-audit/doc-238-casing-consistency
Draft

hlenke wants to merge 2 commits into
mainfrom
docs-audit/doc-238-casing-consistency

Conversation

@hlenke

@hlenke hlenke commented Oct 28, 2026

Copy link
Copy Markdown
Member

Fixes DOC-238.

The docs spell the same things in many ways. "Multistep checks" alone appeared as Multistep Checks, MultiStep Checks, multi-step checks and multistep checks. This PR takes the pattern from Laura's capitalization commits (c0043be, 2f3d950) and applies it across the docs in one go.

Rules

  1. Check and monitor types: capitalize the type and keep the noun lowercase, for example Browser checks, Multistep checks, API checks, URL monitors, TCP monitors and Heartbeat monitors. "Playwright Check Suite" stays as it is.
  2. Other features: lowercase in a sentence, for example status page, alert channel, check group, private location and maintenance window. Headings use sentence case.
  3. Third-party names: the vendor's own casing, for example GitHub, JavaScript, TypeScript, Node.js, PagerDuty, OpenTelemetry and Opsgenie.

Not changed

  • Code blocks (including their comments), inline code, commands, package and construct names (BrowserCheck, MultiStepCheck), URLs and anchors.
  • UI labels quoted exactly as the app or a vendor shows them, for example "Continue with Github", "Alert with Pagerduty" and the Jenkins "NodeJS plugin".
  • changelog/, which is a historical record.

How it was checked

  • A script compared every changed line with main. All 806 lines in 225 files differ only in letter case, plus "multi-step" → "Multistep" and NodeJS → Node.js. None are inside code fences, and inline code, links, hrefs and imports are unchanged.
  • Case-only heading changes don't change Mintlify anchors, and no link uses a #multi-step… anchor.
  • npm run check:links passes and vale reports no errors.
  • A recount in prose went from 36 to 0 for "Multistep Checks", 46 to 0 for "Browser Checks", 37 to 0 for "Private Locations", 24 to 1 for "Pagerduty" (a UI label) and 10 to 0 for "OpsGenie".

The diff touches many files but every change is mechanical. Reviewing per directory works well.

🤖 Generated with Claude Code

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>
@mintlify

mintlify Bot commented Oct 28, 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 Oct 28, 2026, 8:58 PM

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>

This branch was successfully deployed

1 active deployment
staging — e362521f Deployed Oct 28, 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