Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2bdaf05
docs: redesign the docs homepage after the Cloudflare developer docs …
Dgiordano33 Oct 19, 2026
f4fd00b
chore: regenerate package-lock.json with npm 10 so npm ci passes
Dgiordano33 Oct 19, 2026
ac1fa19
Use Tabler icons across documentation
Dgiordano33 Oct 20, 2026
90d543f
Match product icons to Checkly app navigation
Dgiordano33 Oct 20, 2026
eccdcda
Simplify homepage news dates and fill feature grid
Dgiordano33 Oct 20, 2026
20b6a02
Remove homepage news category labels
Dgiordano33 Oct 20, 2026
09bd08d
Feature Rocky AI in homepage Resolve tab
Dgiordano33 Oct 20, 2026
32beaf1
Use CLI example in homepage Rocky AI tab
Dgiordano33 Oct 20, 2026
918ac95
Simplify Resolve example to check retrieval command
Dgiordano33 Oct 20, 2026
10c3e05
Update homepage positioning for engineers and agents
Dgiordano33 Oct 20, 2026
ff302bd
Remove Build with Checkly card eyebrows and icons
Dgiordano33 Oct 22, 2026
c9acadb
Remove homepage section divider lines
Dgiordano33 Oct 26, 2026
838e288
Add homepage monitoring use case groups
Dgiordano33 Oct 26, 2026
26967b4
Match homepage typography to standard docs pages
Dgiordano33 Oct 26, 2026
a4e8c7c
Merge branch 'main' into Dgiordano33/cloudflare-homepage-redesign
Dgiordano33 Oct 26, 2026
76f9ef2
Match docs homepage buttons to marketing styles
Dgiordano33 Oct 26, 2026
0e9567c
Merge remote-tracking branch 'origin/Dgiordano33/cloudflare-homepage-…
Dgiordano33 Oct 26, 2026
e39d12b
Fix homepage review findings
Dgiordano33 Oct 27, 2026
8b39e22
Align homepage setup prompt with init and refine copy
Dgiordano33 Oct 27, 2026
377af07
Update homepage agent prompt hint
Dgiordano33 Oct 27, 2026
a7a7345
Fix homepage prompt copying with Mintlify accordion
Dgiordano33 Oct 27, 2026
259473b
Keep homepage copy prompt hidden without preview UI
Dgiordano33 Oct 27, 2026
701a291
Link homepage updates to changelog section anchors
Dgiordano33 Oct 27, 2026
19449b2
Replace featured update dots with Checkly marketing waves
Dgiordano33 Oct 27, 2026
f8a9cf5
Use faint marketing waves across the entire featured card
Dgiordano33 Oct 27, 2026
c4d642e
Restore bottom wave with stronger blue opacity
Dgiordano33 Oct 27, 2026
23de980
Fix homepage Slack example discovery and prerequisite
Dgiordano33 Oct 27, 2026
513df23
Move homepage Slack prerequisite into example comment
Dgiordano33 Oct 27, 2026
2d8b68a
Merge origin/main into homepage redesign branch
Dgiordano33 Oct 27, 2026
b1c4f22
Update index.mdx
Dgiordano33 Oct 27, 2026
4d21319
Merge branch 'main' into Dgiordano33/cloudflare-homepage-redesign
Dgiordano33 Oct 28, 2026
3c657fa
Clarify homepage monitor creation options
Dgiordano33 Oct 28, 2026
83fe555
Merge branch 'main' into Dgiordano33/cloudflare-homepage-redesign
Dgiordano33 Oct 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference-old/alert-channels/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,15 +204,15 @@ if ($httpCode === 200) {

<Columns cols={2}>

<Card title="Configuration Validation" icon="check-circle">
<Card title="Configuration Validation" icon="circle-check">
Retrieve alert channel details to verify configuration before subscribing checks
</Card>

<Card title="Audit Trail" icon="clock">
Check creation and modification timestamps for compliance and tracking
</Card>

<Card title="Integration Management" icon="cog">
<Card title="Integration Management" icon="settings">
Get current webhook URLs or settings for updating external systems
</Card>

Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/analytics/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ These are general guidelines; thresholds should be set based on your specific SL
Success rate targets should align with your SLA commitments.
</Card>

<Card title="Heartbeat Reliability" icon="heartbeat">
<Card title="Heartbeat Reliability" icon="activity-heartbeat">
**Excellent:** ≥ 99.9% uptime
**Good:** 99.0% - 99.9% uptime
**Fair:** 95.0% - 99.0% uptime
Expand Down
6 changes: 3 additions & 3 deletions api-reference-old/check-alerts/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ GET /v1/check-alerts/{checkId}?alertType=performance_degradation
```
</Card>

<Card title="Incident Response Analysis" icon="users-cog">
<Card title="Incident Response Analysis" icon="users-group">
Evaluate team response times and incident handling
```bash
GET /v1/check-alerts/{checkId}?severity=critical&status=resolved
```
</Card>

<Card title="Alert Optimization" icon="sliders-h">
<Card title="Alert Optimization" icon="adjustments-horizontal">
Optimize alert thresholds and reduce false positives
```bash
GET /v1/check-alerts/{checkId}?period=90d&limit=100
Expand Down Expand Up @@ -211,7 +211,7 @@ GET /v1/check-alerts/{checkId}?period=90d&limit=100
- **Escalation Rate**: Percentage of alerts that escalated
</Card>

<Card title="Alert Patterns" icon="pattern">
<Card title="Alert Patterns" icon="template">
- **Peak Alert Hours**: Times when most alerts occur
- **Location Breakdown**: Alerts by monitoring location
- **Severity Distribution**: Breakdown of alert severities
Expand Down
10 changes: 5 additions & 5 deletions api-reference-old/check-alerts/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ This endpoint returns all alerts that have been triggered by checks in your acco

<Columns cols={2}>

<Card title="Incident Response" icon="exclamation-triangle">
<Card title="Incident Response" icon="alert-triangle">
Monitor and respond to active incidents in real-time
```bash
GET /v1/check-alerts?status=triggered&severity=high
Expand Down Expand Up @@ -172,7 +172,7 @@ GET /v1/check-alerts?acknowledgedBy=null&severity=critical

<Columns cols={2}>

<Card title="Check Failure" icon="exclamation-triangle">
<Card title="Check Failure" icon="alert-triangle">
**Triggered when:**
- HTTP status codes indicate failure (4xx, 5xx)
- Network timeouts or connection errors
Expand All @@ -185,7 +185,7 @@ GET /v1/check-alerts?acknowledgedBy=null&severity=critical
- Database connection timeouts
</Card>

<Card title="Check Recovery" icon="check-circle">
<Card title="Check Recovery" icon="circle-check">
**Triggered when:**
- Previously failing check returns to success
- Performance returns to acceptable levels
Expand All @@ -197,7 +197,7 @@ GET /v1/check-alerts?acknowledgedBy=null&severity=critical
- Temporary issues have resolved
</Card>

<Card title="Performance Degradation" icon="chart-line-down">
<Card title="Performance Degradation" icon="trending-down">
**Triggered when:**
- Response times exceed thresholds
- Success rates drop below limits
Expand All @@ -209,7 +209,7 @@ GET /v1/check-alerts?acknowledgedBy=null&severity=critical
- Success rate < 95%
</Card>

<Card title="Heartbeat Missing" icon="heartbeat">
<Card title="Heartbeat Missing" icon="activity-heartbeat">
**Triggered when:**
- Expected heartbeat signals not received
- Service health checks fail
Expand Down
12 changes: 6 additions & 6 deletions api-reference-old/check-status/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,14 @@ This endpoint provides real-time status information for all checks in your accou

<Columns cols={2}>

<Card title="System Health Dashboard" icon="tachometer-alt">
<Card title="System Health Dashboard" icon="gauge">
Build real-time system health overviews and status pages
```bash
GET /v1/check-statuses?includeSummary=true
```
</Card>

<Card title="Incident Detection" icon="exclamation-triangle">
<Card title="Incident Detection" icon="alert-triangle">
Identify and respond to incidents quickly
```bash
GET /v1/check-statuses?status=failing&hasIncident=false
Expand Down Expand Up @@ -221,7 +221,7 @@ GET /v1/check-statuses?availabilityMin=99&period=30d

<Columns cols={2}>

<Card title="Passing" icon="check-circle">
<Card title="Passing" icon="circle-check">
**Indicates:**
- Recent executions successful
- Availability within acceptable range
Expand All @@ -234,7 +234,7 @@ GET /v1/check-statuses?availabilityMin=99&period=30d
- No active critical alerts
</Card>

<Card title="Failing" icon="x-circle">
<Card title="Failing" icon="circle-x">
**Indicates:**
- Recent executions failed
- Service unavailable or unreachable
Expand All @@ -247,7 +247,7 @@ GET /v1/check-statuses?availabilityMin=99&period=30d
- Active critical alerts
</Card>

<Card title="Degraded" icon="exclamation-triangle">
<Card title="Degraded" icon="alert-triangle">
**Indicates:**
- Intermittent failures
- Performance below targets
Expand All @@ -260,7 +260,7 @@ GET /v1/check-statuses?availabilityMin=99&period=30d
- Response times above thresholds
</Card>

<Card title="Unknown" icon="question-circle">
<Card title="Unknown" icon="help-circle">
**Indicates:**
- Insufficient data to determine status
- Check recently created
Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/checks/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ GET /v1/checks?checkType=BROWSER
```
</Card>

<Card title="Audit Inactive Checks" icon="pause">
<Card title="Audit Inactive Checks" icon="player-pause">
Find paused checks that might need attention
```bash
GET /v1/checks?activated=false
Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/dashboards/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ GET /v1/dashboards?tags=executive,summary
```
</Card>

<Card title="Customer Communication" icon="megaphone">
<Card title="Customer Communication" icon="speakerphone">
Transparent communication during incidents and maintenance
```bash
GET /v1/dashboards?isPrivate=false
Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/environment-variables/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ GET /v1/variables?key=API_*
```
</Card>

<Card title="Environment Settings" icon="cog">
<Card title="Environment Settings" icon="settings">
Configure different values for staging, production, and development
```bash
GET /v1/variables?key=*_ENV
Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/heartbeats/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ if inactive_heartbeats:

<Columns cols={2}>

<Card title="API Health Monitoring" icon="heartbeat">
<Card title="API Health Monitoring" icon="activity-heartbeat">
Monitor API endpoints for availability and response time
</Card>

Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/maintenance-windows/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ for window in data['data']:
Suppress alerts during planned software deployments and updates
</Card>

<Card title="Infrastructure Maintenance" icon="wrench">
<Card title="Infrastructure Maintenance" icon="tool">
Silence monitoring during server maintenance and hardware upgrades
</Card>

Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/private-locations/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The private location is temporarily disabled for maintenance:

<Columns cols={2}>

<Card title="Internal Network Monitoring" icon="network-wired">
<Card title="Internal Network Monitoring" icon="network">
Monitor internal services behind firewalls or in private networks
</Card>

Expand Down
2 changes: 1 addition & 1 deletion api-reference-old/reporting/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ This endpoint provides access to your monitoring reports including scheduled sum
- Customer impact assessment
</Card>

<Card title="Incident Analysis" icon="exclamation-triangle">
<Card title="Incident Analysis" icon="alert-triangle">
**Purpose:** Post-incident learning and improvement
**Frequency:** Triggered by incidents
**Content:** Timeline, impact, recommendations
Expand Down
2 changes: 1 addition & 1 deletion api-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Authentication to the API is performed using the Bearer auth method in the Autho

For example, set the `Authorization` and `X-Checkly-Account` headers when using cURL:

```bash Bash icon="square-terminal"
```bash Bash icon="terminal-2"
curl -H "Authorization: Bearer [apiKey]" -H "X-Checkly-Account: [accountId]"
```

Expand Down
2 changes: 1 addition & 1 deletion changelog/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Release notes for the Checkly Agent
<Card
title="Playwright Reporter"
href="/detect/testing/playwright-reporter-changelog"
icon="vial"
icon="test-pipe-2"
horizontal
>
Release notes for the Checkly Playwright Reporter
Expand Down
6 changes: 3 additions & 3 deletions communicate/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ canonical: 'https://www.checklyhq.com/docs/communicate/overview/'
Receive instant notifications when issues are detected across multiple channels
</Card>

<Card title="Status Pages" href="/communicate/status-pages/overview" icon="globe" horizontal>
<Card title="Status Pages" href="/communicate/status-pages/overview" icon="broadcast" horizontal>
Keep users informed with public status pages and incident communication
</Card>

<Card title="Dashboards" href="/communicate/dashboards/overview" icon="chart-line" horizontal>
<Card title="Dashboards" href="/communicate/dashboards/overview" icon="device-desktop" horizontal>
Create custom views of your monitoring data for teams and stakeholders
</Card>

<Card title="Maintenance Windows" href="/communicate/maintenance-windows/overview" icon="wrench" horizontal>
<Card title="Maintenance Windows" href="/communicate/maintenance-windows/overview" icon="tool" horizontal>
Schedule and communicate planned maintenance to reduce alert noise
</Card>

Expand Down
6 changes: 3 additions & 3 deletions detect/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ canonical: 'https://www.checklyhq.com/docs/detect/overview/'

**Checkly Detect** provides global reliability infrastructure to help test and monitor applications and services for exceptional user experiences. By combining automated testing and monitoring, Checkly helps you identify issues across the entire SDLC; and most importantly, **before they impact your users**.

<Card title="Uptime Monitoring" href="/detect/uptime-monitoring/overview" icon="signal" horizontal>
<Card title="Uptime Monitoring" href="/detect/uptime-monitoring/overview" icon="activity" horizontal>
Monitor availability and response times across your website and infrastructure
</Card>

<Card title="Synthetic Monitoring" href="/detect/synthetic-monitoring/overview" icon="robot" horizontal>
<Card title="Synthetic Monitoring" href="/detect/synthetic-monitoring/overview" icon="activity" horizontal>
Proactively validate real user interactions with API, browser, and multistep checks
</Card>

<Card title="Testing" href="/detect/testing/overview" icon="flask" horizontal>
<Card title="Testing" href="/detect/testing/overview" icon="list-check" horizontal>
Run automated Playwright tests to validate functionality and user workflows before production
</Card>

Expand Down
2 changes: 1 addition & 1 deletion detect/synthetic-monitoring/api-checks/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ API checks are automated HTTP requests that validate API endpoint functionality
- Third-party API dependency monitoring
- Payment and transaction APIs

<Accordion title="Key capabilities" icon="api">
<Accordion title="Key capabilities" icon="braces">
- HTTP method support (GET, POST, PUT, DELETE, etc.)
- Request/response validation
- JSON path assertions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,21 @@ You can use this data to quickly find issues with the pages you visit. Use cases
For each page your script visits, we automatically collect a set of five [Web Vitals](https://web.dev/learn-web-vitals/).
Web Vitals are user focused quality signals for web pages that indicate a good, ok or poor user experience.

<Accordion title="First Contentful Paint (FCP)" icon="paintbrush">
<Accordion title="First Contentful Paint (FCP)" icon="brush">
**Initial Content Display**
Measures the time from when the page starts loading to when any content is rendered. A large FCP means users see a white screen for too long, doubting whether the page works at all.

[Read more about FCP over at web.dev](https://web.dev/fcp/)
</Accordion>

<Accordion title="Largest Contentful Paint (LCP)" icon="image">
<Accordion title="Largest Contentful Paint (LCP)" icon="photo">
**Main Content Loading**
Measures the time to render the largest visual item within the browser viewport. High LCP means users wait too long before the most useful part of your page loads.

[Read more about LCP over at web.dev](https://web.dev/lcp/)
</Accordion>

<Accordion title="Cumulative Layout Shift (CLS)" icon="arrows-to-circle">
<Accordion title="Cumulative Layout Shift (CLS)" icon="arrows-minimize">
**Visual Stability**
An aggregate metric that signals screen elements "jumping around" as the page loads. Low CLS means you have a stable page layout.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,10 @@ Checkly cloud automatically.
Learn more about setting up the Checkly CLI for your CI/CD pipeline 👇

<Cards>
<Card title="GitHub Actions" href="/integrations/ci-cd/github/actions" icon="github" />
<Card title="GitLab CI/CD" href="/integrations/ci-cd/gitlab" icon="gitlab" />
<Card title="Jenkins" href="/integrations/ci-cd/jenkins" icon="jenkins" />
<Card title="Vercel" href="/integrations/ci-cd/vercel" icon="vercel" />
<Card title="GitHub Actions" href="/integrations/ci-cd/github/actions" icon="brand-github" />
<Card title="GitLab CI/CD" href="/integrations/ci-cd/gitlab" icon="brand-gitlab" />
<Card title="Jenkins" href="/integrations/ci-cd/jenkins" icon="/images/jenkins-logo.svg" />
<Card title="Vercel" href="/integrations/ci-cd/vercel" icon="brand-vercel" />
</Cards>

## Known limitations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ Each row is one page visit. Expand a row to see what drove its largest paint and

For each page a test visits, Checkly collects six [Web Vitals](https://web.dev/learn-web-vitals/) and scores each one good, needs improvement, or poor against the canonical [web.dev thresholds](https://web.dev/articles/defining-core-web-vitals-thresholds).

<Accordion title="First Contentful Paint (FCP)" icon="paintbrush">
<Accordion title="First Contentful Paint (FCP)" icon="brush">
**Initial Content Display**
Measures the time from when the page starts loading to when any content is rendered. A large FCP means users see a white screen for too long, doubting whether the page works at all.

[Read more about FCP over at web.dev](https://web.dev/fcp/)
</Accordion>

<Accordion title="Largest Contentful Paint (LCP)" icon="image">
<Accordion title="Largest Contentful Paint (LCP)" icon="photo">
**Main Content Loading**
Measures the time to render the largest visual item within the browser viewport. High LCP means users wait too long before the most useful part of your page loads.

[Read more about LCP over at web.dev](https://web.dev/lcp/)
</Accordion>

<Accordion title="Cumulative Layout Shift (CLS)" icon="arrows-to-circle">
<Accordion title="Cumulative Layout Shift (CLS)" icon="arrows-minimize">
**Visual Stability**
An aggregate metric that signals screen elements "jumping around" as the page loads. Low CLS means you have a stable page layout.

Expand All @@ -64,7 +64,7 @@ Indicates how long it took for your server to respond with the first byte of con
[Read more about TTFB over at web.dev](https://web.dev/time-to-first-byte/)
</Accordion>

<Accordion title="Interaction to Next Paint (INP)" icon="hand-pointer">
<Accordion title="Interaction to Next Paint (INP)" icon="hand-click">
**Interaction Responsiveness**
Measures how quickly the page responds to user interactions like clicks, taps, and key presses, from the input to the next frame painted. A high INP means interactions feel sluggish.

Expand Down
9 changes: 6 additions & 3 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "aspen",
"icons": {
"library": "tabler"
},
"name": "Checkly Docs",
"colors": {
"primary": "#0075FF",
Expand Down Expand Up @@ -1287,7 +1290,7 @@
},
{
"dropdown": "Incidents",
"icon": "triangle-exclamation",
"icon": "alert-triangle",
"pages": [
"learn/incidents/overview",
{
Expand Down Expand Up @@ -1336,7 +1339,7 @@
},
{
"dropdown": "Kubernetes",
"icon": "dharmachakra",
"icon": "steering-wheel",
"pages": [
"learn/kubernetes/overview",
"learn/kubernetes/centralized-logging",
Expand Down Expand Up @@ -1386,7 +1389,7 @@
},
{
"dropdown": "OpenTelemetry",
"icon": "satellite-dish",
"icon": "satellite",
"pages": [
"learn/opentelemetry/overview",
{
Expand Down
Loading
Loading