Repository navigation
Conversation
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
hlenke
left a comment
There was a problem hiding this comment.
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 ServerbecomesCheckly MCP serverin 3 page titles and 2 Card titles. Thedocs.jsonnav group staysMCP Server, becausedocs.jsonis 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 ReporterbecomesPlaywright reporterin 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
15169559withorigin/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 ingit diff --unified=0and compares them lowercased. All 1,819 pairs match, every hunk has as many removed lines as added, and nothing else changed: nohref, 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.pyreported 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: onlyc6fb6612.- Overlap:
gh pr list --json number,files, thengit diff --name-onlyon the shared paths. - Release-bot changelog syncs (#576, #595) only insert
<Update>blocks and don't rewrite the title, so the newplaywright-reporter-changelog.mdxtitle should survive future syncs. git greponorigin/mainfor 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 |
There was a problem hiding this comment.
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:
| sidebarTitle: Deployment protection | |
| sidebarTitle: Deployment Protection |
| ``` | ||
|
|
||
| ## Vercel Authentication | ||
| ## Vercel authentication |
There was a problem hiding this comment.
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.
| ## Vercel authentication | |
| ## Vercel Authentication |
| --- | ||
|
|
||
| ## Transformations Using OpenTelemetry Transform Language (OTTL) | ||
| ## Transformations using OpenTelemetry transform language (OTTL) |
There was a problem hiding this comment.
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".
| ## Transformations using OpenTelemetry transform language (OTTL) | |
| ## Transformations using OpenTelemetry Transform Language (OTTL) |
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
.mdxfiles. 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
titleandsidebarTitle, andtitleprops on<Tab>,<Card>,<Accordion>and<Step>.The branch was rebuilt on current
main: mergingmainconflicted in 55 files, so the case-only changes were reapplied to main's text. That also converted 9 title-case headings and titles added tomainsince.Kept as is
<YoutubeEmbed>titles,api-reference/**,api-reference-old/**anddocs.json.How it was verified
hrefs, links, inline code, anchorscheck-anchors#fragmentresolvesNot changed
docs.jsonnavigation labels.🤖 Generated with Claude Code
https://claude.ai/code/session_01WL5whrFpHCtRKygwuMxU8e