Skip to content

Commit a1bcfb2

Browse files
committed
AI Messaging in Concepts and Sidebar
1 parent 62b3ad7 commit a1bcfb2

10 files changed

Lines changed: 164 additions & 160 deletions

File tree

ai/overview.mdx

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'AI Agents & Coding Assistants'
33
description: 'Use AI agents and coding assistants to create, update, and deploy your Checkly monitoring setup with skills and rules.'
4-
sidebarTitle: 'Overview'
4+
sidebarTitle: 'Agents & Checkly'
55
keywords: ['mcp', 'ai', 'rules', 'generate checks', 'agents', 'context']
66
---
77

@@ -74,3 +74,92 @@ Whether you need to configure your monitoring setup, access check data or declar
7474
<Tip>
7575
We are researching additional AI-native workflows. [Let us know in the public roadmap](https://feedback.checklyhq.com/p/checkly-mcp) if you are interested in more agent-friendly integrations.
7676
</Tip>
77+
78+
## Markdown access
79+
80+
Every page in the Checkly documentation is available as markdown. This makes it easy to feed specific documentation pages into AI assistants like Claude, ChatGPT, Cursor, or any other AI tool.
81+
82+
<Tip>
83+
Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation.
84+
</Tip>
85+
86+
### .md endpoints
87+
88+
Append `.md` to any documentation URL to get the markdown version of that page.
89+
90+
**Example:**
91+
92+
- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/`
93+
- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md`
94+
95+
The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables.
96+
97+
```bash
98+
# Fetch documentation content with curl
99+
curl https://www.checklyhq.com/docs/what-is-checkly.md
100+
101+
# Pipe directly to your clipboard
102+
curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy
103+
```
104+
105+
### Content negotiation
106+
107+
You can also request markdown by setting the `Accept` header to `text/markdown`:
108+
109+
```bash
110+
curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/
111+
```
112+
113+
This is useful when integrating with tools or scripts that set request headers programmatically.
114+
115+
<Tip>
116+
Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/).
117+
</Tip>
118+
119+
### Copy as Markdown button
120+
121+
Every documentation page includes a **Copy as Markdown** button at the top of the page. Click it to copy the full page content as markdown to your clipboard.
122+
123+
This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context.
124+
125+
```text
126+
Here is the Checkly Browser Checks documentation:
127+
128+
[paste markdown content]
129+
130+
Based on this, how do I set up a browser check with a custom user agent?
131+
```
132+
133+
134+
## LLMs.txt
135+
136+
137+
The [llms.txt standard](https://llmstxt.org/) provides a machine-readable index of all available documentation pages. Checkly publishes an `llms.txt` file at [`checklyhq.com/llms.txt`](https://www.checklyhq.com/llms.txt) that lists every documentation page with its markdown URL and a short description.
138+
139+
```txt llms.txt (first 15 lines)
140+
# Checkly Docs
141+
142+
## Docs
143+
144+
- [Changing your email or password in Checkly](https://checklyhq.com/docs/admin/changing-your-email-password.md): Learn how to change your email address or password in your Checkly account
145+
- [Creating an API key in Checkly](https://checklyhq.com/docs/admin/creating-api-key.md): Learn how to create and manage user and service API keys for the Checkly API and CLI
146+
- [Adding team members to your Checkly account](https://checklyhq.com/docs/admin/team-management/adding-team-members.md): Learn how to invite team members to join your Checkly account and manage team collaboration
147+
- [Using Microsoft Entra ID for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/microsoft-azure-ad.md): This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly.
148+
- [Multi-Factor Authentication in Checkly](https://checklyhq.com/docs/admin/team-management/multi-factor-authentication.md): Learn how to set up and manage multi-factor authentication for enhanced account security
149+
- [Using Okta for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/okta.md): This page illustrates the standard procedure to follow in order to get started with Okta SSO on Checkly.
150+
- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members
151+
- [Removing team members from your Checkly account](https://checklyhq.com/docs/admin/team-management/removing-team-members.md): Learn how to remove team members from your Checkly account and understand how it affects your billing
152+
- [Using SAML for Single Sign-On in Checkly](https://checklyhq.com/docs/admin/team-management/saml-sso.md): Learn how to set up SAML-based SSO for your Checkly account with supported identity providers
153+
- [Using SCIM provisioning in Checkly](https://checklyhq.com/docs/admin/team-management/scim-provisioning.md): Learn how to set up SCIM provisioning for Checkly using your identity provider
154+
- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly
155+
```
156+
157+
Use the `llms.txt` file to crawl and index the entire Checkly documentation. Every link in the file points to [the `.md` version of the page](/ai/markdown-access#md-endpoints), so you can fetch each URL directly to get the markdown content.
158+
159+
```bash
160+
# Fetch the llms.txt index
161+
curl https://www.checklyhq.com/llms.txt
162+
163+
# Fetch a specific page from the index
164+
curl https://checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview.md
165+
```
File renamed without changes.

ai/skills.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Checkly Skills'
33
description: 'Install Checkly skills to give your AI agent on-demand monitoring context and capabilities.'
4-
sidebarTitle: 'Skills'
4+
sidebarTitle: 'Agent Skills'
55
---
66

77
Skills are reusable and modular capabilities for AI agents. They provide procedural knowledge that helps agents accomplish Checkly tasks more effectively. Think of Checkly Skills as plugins or extensions that enhance what your AI agent can do with your monitoring infrastructure.

communicate/overview.mdx

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,10 @@ Schedule and communicate planned maintenance to reduce alert noise
2525

2626
## Key Benefits
2727

28-
<AccordionGroup>
29-
<Accordion title="Multi-Channel Alerting">
30-
Send notifications through email, SMS, Slack, webhooks, and more to ensure critical issues reach the right people.
31-
</Accordion>
32-
33-
<Accordion title="Transparent Status Communication">
34-
Build trust with users through branded status pages that provide real-time system status and incident updates.
35-
</Accordion>
36-
37-
<Accordion title="Customizable Dashboards">
38-
Create tailored views of monitoring data that match your team's workflow and stakeholder needs.
39-
</Accordion>
40-
41-
<Accordion title="Intelligent Alert Management">
42-
Reduce alert fatigue with escalation policies, maintenance windows, and smart notification routing.
43-
</Accordion>
44-
</AccordionGroup>
28+
- **Multi-Channel Alerting** — Send notifications through email, SMS, Slack, webhooks, and more to ensure critical issues reach the right people.
29+
- **Transparent Status Communication** — Build trust with users through branded status pages that provide real-time system status and incident updates.
30+
- **Customizable Dashboards** — Create tailored views of monitoring data that match your team's workflow and stakeholder needs.
31+
- **Intelligent Alert Management** — Reduce alert fatigue with escalation policies, maintenance windows, and smart notification routing.
4532

4633
## How It Works
4734

detect/overview.mdx

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,17 @@ Run automated Playwright tests to validate functionality and user workflows befo
2323

2424
## Key Benefits
2525

26-
<Accordion title="Early, Proactive Issue Detection">
27-
Identify problems before they impact users through proactive monitoring and testing across all application layers.
28-
</Accordion>
29-
30-
<Accordion title="Comprehensive, Global Coverage">
31-
Monitor everything from basic uptime to complex user workflows with multiple monitoring types and global locations.
32-
</Accordion>
33-
34-
<Accordion title="Historical Performance Insights">
35-
Track response times, availability percentages, and user experience metrics to optimize application performance.
36-
</Accordion>
37-
38-
<Accordion title="Automated Validation">
39-
Reduce manual testing overhead with automated checks that run continuously and provide immediate feedback.
40-
</Accordion>
26+
- **Early, Proactive Issue Detection** — Identify problems before they impact users through proactive monitoring and testing across all application layers.
27+
- **Comprehensive, Global Coverage** — Monitor everything from basic uptime to complex user workflows with multiple monitoring types and global locations.
28+
- **Historical Performance Insights** — Track response times, availability percentages, and user experience metrics to optimize application performance.
29+
- **Automated Validation** — Reduce manual testing overhead with automated checks that run continuously and provide immediate feedback.
4130

4231
## How Checkly Works
4332

4433
<Steps>
4534
<Step title="Add Monitors to your project">
4635
Start with the monitoring approach that best fits your immediate needs:
47-
- Create them inside the Checkly UI
36+
- Create them inside the Checkly UI
4837
- Create them in your repository as [constructs](/constructs)
4938
</Step>
5039

@@ -67,20 +56,12 @@ Once you are happy with your monitoring, you can deploy them to production.
6756

6857
## Reliability In Depth Strategy
6958

70-
Implement testing and monitoring across multiple layers. Layering all of these approaches provides a comprehensive view of your application's reliability, from the infrastructure layer to the user experience layer. With Checkly, monitor everything from your homepage availability to the most complex user journeys in a single platform.
71-
72-
73-
#### Automated Testing
74-
Run automated unit, integration, and end-to-end Tests to validate functionality and user workflows before production
75-
76-
#### Uptime Monitoring
77-
Monitor servers, databases, and network connectivity to ensure your applications are available and responsive
78-
79-
#### API Synthetic Monitoring
80-
Validate API endpoints and microservice communication
59+
Implement testing and monitoring across multiple layers for a comprehensive view of your application's reliability, from infrastructure to user experience. With Checkly, monitor everything from homepage availability to the most complex user journeys in a single platform.
8160

82-
#### Browser Synthetic Monitoring
83-
Validate user journeys and interactions in a real browser environment
61+
- **Automated Testing** — Run unit, integration, and end-to-end tests to validate functionality and user workflows before production
62+
- **Uptime Monitoring** — Monitor servers, databases, and network connectivity to ensure availability and responsiveness
63+
- **API Synthetic Monitoring** — Validate API endpoints and microservice communication
64+
- **Browser Synthetic Monitoring** — Validate user journeys and interactions in a real browser environment
8465

8566

8667
## Getting Started
@@ -103,4 +84,4 @@ Create comprehensive user experience validation
10384

10485
<Note>
10586
For maximum reliability, combine all three monitoring approaches. Start with one type and gradually expand your coverage to create a comprehensive monitoring strategy.
106-
</Note>
87+
</Note>

docs.json

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"name": "Checkly Docs",
55
"colors": {
66
"primary": "#0075FF",
7-
"light": "#0075FF",
7+
"light": "#2B8AFF",
88
"dark": "#031834"
99
},
1010
"seo": {
@@ -22,9 +22,6 @@
2222
}
2323
],
2424
"integrations": {
25-
"intercom": {
26-
"appId": "ep3ft8gg"
27-
},
2825
"segment": {
2926
"key": "Bjlk6vx065LS2B25zVBzcfsjTaGrrpAM"
3027
},
@@ -104,7 +101,6 @@
104101
"platform/runtimes/runtime-specification"
105102
]
106103
},
107-
"platform/rocky-ai",
108104
"platform/secrets",
109105
"platform/dynamic-secret-scrubbing",
110106
"platform/data-storage",
@@ -137,8 +133,7 @@
137133
},
138134
"admin/changing-your-email-password"
139135
]
140-
},
141-
"changelog/changelog"
136+
}
142137
]
143138
},
144139
{
@@ -297,6 +292,7 @@
297292
"group": "Resolve",
298293
"pages": [
299294
"resolve/overview",
295+
"resolve/ai-root-cause-analysis/overview",
300296
{
301297
"group": "Traces",
302298
"pages": [
@@ -336,23 +332,17 @@
336332
]
337333
}
338334
]
339-
},
340-
"resolve/ai-root-cause-analysis/overview"
335+
}
336+
341337
]
342338
},
343339
{
344340
"group": "AI",
345341
"pages": [
346-
{
347-
"group": "Agent resources",
348-
"pages": [
349-
"ai/overview",
342+
"ai/rocky-ai",
343+
"ai/overview",
350344
"ai/skills",
351-
"ai/markdown-access",
352-
"ai/llms-txt",
353345
"ai/rules"
354-
]
355-
}
356346
]
357347
},
358348
{
@@ -523,7 +513,7 @@
523513
]
524514
},
525515
{
526-
"tab": "CLI",
516+
"tab": "CLI Reference",
527517
"pages": [
528518
{
529519
"group": "Getting Started",
@@ -564,7 +554,7 @@
564554
]
565555
},
566556
{
567-
"tab": "API",
557+
"tab": "API Reference",
568558
"pages": [
569559
{
570560
"group": "Getting Started",
@@ -942,6 +932,12 @@
942932
"guides/overview"
943933
]
944934
},
935+
{
936+
"group": "AI and LLMs",
937+
"pages": [
938+
"guides/agentic-workflows"
939+
]
940+
},
945941
{
946942
"group": "Monitoring Guides",
947943
"pages": [
@@ -981,12 +977,7 @@
981977
"guides/reading-traces"
982978
]
983979
},
984-
{
985-
"group": "AI and LLMs",
986-
"pages": [
987-
"guides/agentic-workflows"
988-
]
989-
},
980+
990981
{
991982
"group": "Advanced Topics",
992983
"pages": [
@@ -1239,6 +1230,10 @@
12391230
{
12401231
"label": "Home",
12411232
"href": "https://www.checklyhq.com"
1233+
},
1234+
{
1235+
"label": "Changelog",
1236+
"href": "https://www.checklyhq.com/changelog"
12421237
}
12431238
],
12441239
"primary": {

resolve/ai-root-cause-analysis/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Rocky AI Root Cause Analysis
33
description: Automatically perform root cause and user impact analysis with Rocky AI
4-
sidebarTitle: Rocky AI Root Cause Analysis
4+
sidebarTitle: AI Root Cause Analysis
55
---
66

77
## What is Rocky AI Root Cause Analysis?

resolve/overview.mdx

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,10 @@ Let Rocky AI analyze errors, metrics, traces and logs and determine impact and r
1717

1818
## Key Benefits
1919

20-
<AccordionGroup>
21-
<Accordion title="Fast Root Cause Analysis">
22-
Identify the exact source of issues with detailed request tracing across your entire application stack.
23-
</Accordion>
24-
25-
<Accordion title="AI-Powered Insights">
26-
Get intelligent analysis and recommendations from Rocky AI to resolve incidents faster than ever.
27-
</Accordion>
28-
29-
<Accordion title="Full Request Visibility">
30-
See complete request flows from frontend to backend, including database queries and external API calls.
31-
</Accordion>
32-
33-
<Accordion title="Performance Optimization">
34-
Identify slow operations and bottlenecks to proactively improve application performance.
35-
</Accordion>
36-
</AccordionGroup>
20+
- **Fast Root Cause Analysis** — Identify the exact source of issues with detailed request tracing across your entire application stack.
21+
- **AI-Powered Insights** — Get intelligent analysis and recommendations from Rocky AI to resolve incidents faster than ever.
22+
- **Full Request Visibility** — See complete request flows from frontend to backend, including database queries and external API calls.
23+
- **Performance Optimization** — Identify slow operations and bottlenecks to proactively improve application performance.
3724

3825
## Getting Started
3926

0 commit comments

Comments
 (0)