Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
91b1c52
ai quickstart
Dgiordano33 Jun 16, 2026
2a0e7b2
cleaned
Dgiordano33 Jun 16, 2026
70d6660
Browser Check
Dgiordano33 Jun 17, 2026
a2d000c
Rework general quickstart around the AI-agent setup flow
stefanjudis Jun 26, 2026
98478c6
Note that SetupFlow component is AI generated
stefanjudis Jun 26, 2026
49f0906
Merge branch 'main' into docs/general-quickstart-ai-flow
stefanjudis Jun 26, 2026
b1811bf
Tighten AI-voice copy in general quickstart agent path
stefanjudis Jun 26, 2026
486eff7
Make agent-path section a what-it-might-do list
stefanjudis Jun 26, 2026
af6f497
Add deploy step to agent what-it-might-do list
stefanjudis Jun 26, 2026
9874a49
Move deploy to end of agent what-it-might-do list
stefanjudis Jun 26, 2026
fd02296
Center the agent sparkle icon in SetupFlow tile
stefanjudis Jun 26, 2026
4e9ba39
Center step labels in SetupFlow rail; revert icon change
stefanjudis Jun 26, 2026
a3925fb
Move check-type quickstarts into their Detect sections
stefanjudis Jun 26, 2026
b9de65f
Order check-type sections as overview then quickstart
stefanjudis Jun 26, 2026
918c94a
Fold creating-a-browser-check into the browser check quickstart
stefanjudis Jun 26, 2026
892007a
Drop misleading URL/Create Check bullets from browser check quickstart
stefanjudis Jun 26, 2026
9319416
Reword browser check step 1 to pick the Browser Check template
stefanjudis Jun 26, 2026
b5edbe1
Reword to choose from one of the Browser Check templates
stefanjudis Jun 26, 2026
ac87040
Potential fix for pull request finding
stefanjudis Jun 26, 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 detect/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ Ready to start monitoring your applications? Choose the approach that best fits
Begin with automated testing for development workflows
</Card>

<Card title="Create Your First Uptime Monitor" href="/quickstarts/url-monitor">
<Card title="Create Your First Uptime Monitor" href="/detect/uptime-monitoring/url-monitors/quickstart">
Set up basic availability monitoring for critical services
</Card>

<Card title="Create Your First Synthetic Check" href="/quickstarts/api-check">
<Card title="Create Your First Synthetic Check" href="/detect/synthetic-monitoring/api-checks/quickstart">
Create comprehensive user experience validation
</Card>
</CardGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating An API Check'
description: 'Step-by-step guide to creating your first API check in Checkly using the web UI and CLI.'
sidebarTitle: 'API Check'
sidebarTitle: 'Quickstart'
---

<Tip>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating A Browser Check'
description: 'Get started with Checkly by creating your first Browser Check'
sidebarTitle: 'Browser Check'
sidebarTitle: 'Quickstart'
---

import CliAuth from '/snippets/cli-auth.mdx';
Expand All @@ -13,7 +13,7 @@ Learn more about all the [Browser Check capabilities](/detect/synthetic-monitori

This guide will walk you through creating your first Browser Check with Checkly.

Browser Checks are perfect for monitoring realistic user flows within your application or services. If you are looking for monitoring general availability, check out the [Uptime Monitor Quickstart](/quickstarts/url-monitor).
Browser Checks are perfect for monitoring realistic user flows within your application or services. If you are looking for monitoring general availability, check out the [Uptime Monitor Quickstart](/detect/uptime-monitoring/url-monitors/quickstart).

<Accordion title="Prerequisites">
- A Checkly account (sign up at [checklyhq.com](https://checklyhq.com))
Expand All @@ -23,10 +23,21 @@ Browser Checks are perfect for monitoring realistic user flows within your appli

<Steps>
<Step title="Create a Browser Check">


- **Head to [Create a Check](https://app.checklyhq.com/accounts/create)**
- **Choose "Browser Check"** for comprehensive website monitoring
<Frame>
<img
className="block dark:hidden"
src="/images/next/quickstart-welcome-light.png"
alt="Light mode interface"
/>
<img
className="hidden dark:block"
src="/images/next/quickstart-welcome-dark.png"
alt="Dark mode interface"
/>
</Frame>

1. **Head to [Create a Check](https://app.checklyhq.com/accounts/create)**
2. **Choose from one of the Browser Check templates** to start from a working example
</Step>

<Step title="Edit Your Test Script">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating A Multistep Check'
description: 'Step-by-step guide to creating your first multistep check in Checkly for monitoring complex API workflows and business processes.'
sidebarTitle: 'Multistep Check'
sidebarTitle: 'Quickstart'
---

<Tip>
Expand Down
2 changes: 1 addition & 1 deletion detect/synthetic-monitoring/playwright-checks/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Customize how your checks run:
## Getting Started

<Columns cols={2}>
<Card title="Quickstart Guide" href="/quickstarts/playwright-check">
<Card title="Quickstart Guide" href="/detect/synthetic-monitoring/playwright-checks/quickstart">
Deploy your first Playwright Check Suite
</Card>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating a Playwright Check Suite'
description: 'Turn your Playwright tests into production monitors by creating a checkly.config.ts file'
sidebarTitle: 'Playwright Check Suite'
sidebarTitle: 'Quickstart'
---

import { CopyPromptButton } from "/snippets/copy-prompt-button.jsx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating A Heartbeat Monitor'
description: 'Step-by-step guide to set up your first heartbeat monitor in Checkly. Learn about configuration, timing, alerts, and best practices.'
sidebarTitle: Heartbeat Monitor
sidebarTitle: 'Quickstart'
---

<Tip>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating A TCP Monitor'
description: 'Step-by-step guide to set up your first TCP monitor and ensure your network services are always available.'
sidebarTitle: 'TCP Monitor'
sidebarTitle: 'Quickstart'
---

<Tip>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Creating A URL Monitor'
description: 'Step-by-step guide to set up your first URL monitor and ensure your websites and APIs are always accessible.'
sidebarTitle: 'URL Monitor'
sidebarTitle: 'Quickstart'
---

<Tip>
Expand Down
68 changes: 54 additions & 14 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,7 @@
"group": "Getting Started",
"pages": [
"/what-is-checkly",
{
"group": "Quickstarts",
"pages": [
"quickstarts/tcp-monitor",
"quickstarts/url-monitor",
"quickstarts/browser-check",
"quickstarts/playwright-check",
"quickstarts/api-check",
"quickstarts/multistep-check",
"quickstarts/heartbeat-monitor",
"quickstarts/openapi-spec"
]
},
"quickstart",
{
"group": "Concepts",
"pages": [
Expand Down Expand Up @@ -150,13 +138,15 @@
"group": "URL Monitors",
"pages": [
"detect/uptime-monitoring/url-monitors/overview",
"detect/uptime-monitoring/url-monitors/quickstart",
"detect/uptime-monitoring/url-monitors/configuration"
]
},
{
"group": "TCP Monitors",
"pages": [
"detect/uptime-monitoring/tcp-monitors/overview",
"detect/uptime-monitoring/tcp-monitors/quickstart",
"detect/uptime-monitoring/tcp-monitors/configuration"
]
},
Expand All @@ -178,6 +168,7 @@
"group": "Heartbeat Monitors",
"pages": [
"detect/uptime-monitoring/heartbeat-monitors/overview",
"detect/uptime-monitoring/heartbeat-monitors/quickstart",
"detect/uptime-monitoring/heartbeat-monitors/examples"
]
}
Expand All @@ -198,11 +189,13 @@
"group": "API Checks",
"pages": [
"detect/synthetic-monitoring/api-checks/overview",
"detect/synthetic-monitoring/api-checks/quickstart",
"detect/synthetic-monitoring/api-checks/configuration",
"detect/synthetic-monitoring/api-checks/setup-and-teardown",
"detect/synthetic-monitoring/api-checks/snippets",
"detect/synthetic-monitoring/api-checks/api-structure",
"detect/synthetic-monitoring/api-checks/client-certificates",
"detect/synthetic-monitoring/api-checks/openapi-spec",
"detect/synthetic-monitoring/api-checks/troubleshooting"
]
},
Expand All @@ -211,6 +204,7 @@
"group": "Multistep Checks",
"pages": [
"detect/synthetic-monitoring/multistep-checks/overview",
"detect/synthetic-monitoring/multistep-checks/quickstart",
"detect/synthetic-monitoring/multistep-checks/multistep-structure",
"detect/synthetic-monitoring/multistep-checks/degraded-states",
"detect/synthetic-monitoring/multistep-checks/file-system",
Expand All @@ -222,6 +216,7 @@
"group": "Browser Checks",
"pages": [
"detect/synthetic-monitoring/browser-checks/overview",
"detect/synthetic-monitoring/browser-checks/quickstart",
"detect/synthetic-monitoring/browser-checks/mac-structure",
"detect/synthetic-monitoring/browser-checks/performance-metrics",
"detect/synthetic-monitoring/browser-checks/visual-regressions",
Expand All @@ -236,6 +231,7 @@
"group": "Playwright Check Suites",
"pages": [
"detect/synthetic-monitoring/playwright-checks/overview",
"detect/synthetic-monitoring/playwright-checks/quickstart",
"detect/synthetic-monitoring/playwright-checks/configuration",
"detect/synthetic-monitoring/playwright-checks/test-organization",
"detect/synthetic-monitoring/playwright-checks/add-to-group",
Expand Down Expand Up @@ -1327,6 +1323,50 @@
}
},
"redirects": [
{
"source": "/quickstarts/general",
"destination": "/quickstart"
},
{
"source": "/quickstarts/url-monitor",
"destination": "/detect/uptime-monitoring/url-monitors/quickstart"
},
{
"source": "/quickstarts/tcp-monitor",
"destination": "/detect/uptime-monitoring/tcp-monitors/quickstart"
},
{
"source": "/quickstarts/heartbeat-monitor",
"destination": "/detect/uptime-monitoring/heartbeat-monitors/quickstart"
},
{
"source": "/quickstarts/api-check",
"destination": "/detect/synthetic-monitoring/api-checks/quickstart"
},
{
"source": "/quickstarts/openapi-spec",
"destination": "/detect/synthetic-monitoring/api-checks/openapi-spec"
},
{
"source": "/quickstarts/multistep-check",
"destination": "/detect/synthetic-monitoring/multistep-checks/quickstart"
},
{
"source": "/quickstarts/browser-check",
"destination": "/detect/synthetic-monitoring/browser-checks/quickstart"
},
{
"source": "/quickstarts/playwright-check",
"destination": "/detect/synthetic-monitoring/playwright-checks/quickstart"
},
{
"source": "/quickstarts/creating-a-browser-check",
"destination": "/detect/synthetic-monitoring/browser-checks/quickstart"
},
{
"source": "/detect/synthetic-monitoring/browser-checks/creating-a-browser-check",
"destination": "/detect/synthetic-monitoring/browser-checks/quickstart"
},
{
"source": "/ai/rules",
"destination": "/ai/overview"
Expand All @@ -1353,7 +1393,7 @@
},
{
"source": "/constructs/quickstarts/playwright-check",
"destination": "/quickstarts/playwright-check"
"destination": "/detect/synthetic-monitoring/playwright-checks/quickstart"
},
{
"source": "/api-reference/checks/create-an-dns-monitor/",
Expand Down
4 changes: 2 additions & 2 deletions index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Checkly combines **testing**, **monitoring**, and **incident communication** <br
Learn more about how Checkly works for modern teams.
</Card>

<Card title="Quick Start" icon="bolt" href="quickstarts/browser-check/" cta="Get started">
<Card title="Quick Start" icon="bolt" href="/quickstart" cta="Get started">
Get up and running with tests and monitors deployed in 5 minutes.
</Card>
</Columns>
Expand Down Expand Up @@ -98,7 +98,7 @@ Extend the Checkly platform with our powerful REST API and SDKs.
Platform overview
</Card>

<Card title="Create API Check" href="/quickstarts/api-check">
<Card title="Create API Check" href="/detect/synthetic-monitoring/api-checks/quickstart">
Monitor APIs
</Card>

Expand Down
Loading
Loading