Skip to content

Commit ad1de5d

Browse files
stefanjudisstefanjudis
authored
Merge pull request #229 from checkly/docs/ai-section-and-markdown-access
docs: update AI section, skills, and add markdown-access and llms-txt pages
2 parents df588f3 + 9068db7 commit ad1de5d

11 files changed

Lines changed: 158 additions & 30 deletions

‎ai/llms-txt.mdx‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: 'llms.txt'
3+
description: 'Use the Checkly llms.txt file to discover and crawl all available documentation pages as markdown.'
4+
sidebarTitle: 'llms.txt'
5+
---
6+
7+
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.
8+
9+
```txt llms.txt (first 15 lines)
10+
# Checkly Docs
11+
12+
## Docs
13+
14+
- [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
15+
- [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
16+
- [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
17+
- [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.
18+
- [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
19+
- [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.
20+
- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members
21+
- [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
22+
- [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
23+
- [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
24+
- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly
25+
```
26+
27+
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.
28+
29+
```bash
30+
# Fetch the llms.txt index
31+
curl https://www.checklyhq.com/llms.txt
32+
33+
# Fetch a specific page from the index
34+
curl https://checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview.md
35+
```
36+
37+
## Additional resources
38+
39+
- [Markdown Access](/ai/markdown-access)
40+
- [Checkly Skills](/ai/skills)
41+
- [Checkly Rules](/ai/rules)

‎ai/markdown-access.mdx‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: 'Markdown Access'
3+
description: 'Access Checkly documentation as markdown to use with AI assistants and coding agents.'
4+
sidebarTitle: 'Markdown Access'
5+
---
6+
7+
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.
8+
9+
<Tip>
10+
Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation.
11+
</Tip>
12+
13+
## .md endpoints
14+
15+
Append `.md` to any documentation URL to get the markdown version of that page.
16+
17+
**Example:**
18+
19+
- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/`
20+
- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md`
21+
22+
The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables.
23+
24+
```bash
25+
# Fetch documentation content with curl
26+
curl https://www.checklyhq.com/docs/what-is-checkly.md
27+
28+
# Pipe directly to your clipboard
29+
curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy
30+
```
31+
32+
## Content negotiation
33+
34+
You can also request markdown by setting the `Accept` header to `text/markdown`:
35+
36+
```bash
37+
curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/
38+
```
39+
40+
This is useful when integrating with tools or scripts that set request headers programmatically.
41+
42+
<Tip>
43+
Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/).
44+
</Tip>
45+
46+
## Copy as Markdown button
47+
48+
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.
49+
50+
This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context.
51+
52+
```text
53+
Here is the Checkly Browser Checks documentation:
54+
55+
[paste markdown content]
56+
57+
Based on this, how do I set up a browser check with a custom user agent?
58+
```
59+
60+
61+
## Additional resources
62+
63+
- [Checkly Skills](/ai/skills)
64+
- [Checkly Rules](/ai/rules)

integrations/ai/overview.mdx renamed to ai/overview.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ Provide the necessary Checkly context and let your AI agent of choice do the res
4444

4545
## Add Checkly context to your AI agent conversation
4646

47-
Install [Checkly Skills](/integrations/ai/skills) or add the [Checkly Rules](/integrations/ai/rules) to your AI conversation to give your AI agent enough context to perform Checkly-related tasks.
47+
Install [Checkly Skills](/ai/skills) or add the [Checkly Rules](/ai/rules) to your AI conversation to give your AI agent enough context to perform Checkly-related tasks.
4848

4949
<Columns cols={2}>
50-
<Card title="Checkly Skills" href="/integrations/ai/skills" cta="Get started">
50+
<Card title="Checkly Skills" href="/ai/skills" cta="Get started">
5151
Let your agents pull in all required Checkly context on demand.
5252
</Card>
5353

54-
<Card title="Checkly Rules" href="/integrations/ai/rules" cta="Get started">
54+
<Card title="Checkly Rules" href="/ai/rules" cta="Get started">
5555
Include the entire Checkly context in commands or documentation.
5656
</Card>
5757
</Columns>
@@ -67,9 +67,9 @@ Include the entire Checkly context in commands or documentation.
6767

6868
The MCP concept is often used to enable LLMs to interact with external systems. It acts as a bridge between the AI model and the target system, translating natural language commands into actionable API calls or code snippets.
6969

70-
**With Monitoring as Code, Checkly already provides a native way to control your monitoring infrastructure via code and the command line.**
70+
**With Monitoring as Code and agent-friendly CLI commands, Checkly already provides a native way to control your monitoring infrastructure via code and access monitoring results via the command line.**
7171

72-
Whether you need to create new resources or update existing ones, AI can write and update the necessary construct files and execute the Checkly CLI commands autonomously.
72+
Whether you need to configure your monitoring setup, access check data or declare incidents, AI can write and update the necessary construct files and execute the Checkly CLI commands autonomously.
7373

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.

integrations/ai/rules.mdx renamed to ai/rules.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
---
22
title: 'Checkly Rules'
33
description: 'Add Checkly rules files to your AI agent to provide monitoring context for your coding workflow.'
4-
sidebarTitle: 'Checkly Rules'
4+
sidebarTitle: 'Rules'
55
---
66

77
import AgentExamples from "/snippets/agent-example.mdx"
88
import { YoutubeEmbed } from "/snippets/youtube-embed.jsx"
99

10+
<Warning>
11+
Use the Checkly Skills instead if your coding agents supports [Agent Skills](https://agentskills.io).
12+
</Warning>
13+
1014
The [`checkly.rules.md` file](https://www.checklyhq.com/docs/ai/checkly.rules.md) includes best practices, example code and required CLI commands to give your AI workflow enough context to perform Checkly-related tasks.
1115

1216
Once the Checkly rules are included in your AI context window, your agent can effectively assist you in managing your monitoring setup.

integrations/ai/skills.mdx renamed to ai/skills.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
---
22
title: 'Checkly Skills'
33
description: 'Install Checkly skills to give your AI agent on-demand monitoring context and capabilities.'
4-
sidebarTitle: 'Checkly Skills'
4+
sidebarTitle: '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.
88

99
[Agent Skills](https://agentskills.io) are an open standard supported by many AI agents and coding assistants including Claude Code, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot, and others. If your agent supports skills, you can use the Checkly Skills to manage your monitoring setup.
1010

11-
Use [the `skills` CLI](https://www.npmjs.com/package/skills) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/checkly) globally or in your project:
11+
Use [the Checkly CLI `skills` command](/cli/checkly-skills#checkly-skills-install) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/checkly) globally or in your project:
1212

1313
```bash
14+
npx checkly skills install
15+
16+
# or if you prefer the `skills` CLI
1417
npx skills add checkly/checkly-cli
1518
```
1619

@@ -32,7 +35,7 @@ This will make the Checkly Skills available to your AI agent. When your agent ne
3235
⏺ I'll create a new URLMonitor for example.com!
3336
```
3437

35-
Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Just give your agent the necessary context and let it use the Checkly Skills to manage your monitoring setup effectively.
38+
Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Tell your agent what you want to do and it will access the necessary context and use the CLI to manage your monitoring setup effectively.
3639

3740
## Additional resources
3841

‎cli/checkly-skills.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebarTitle: 'checkly skills'
88

99
The `checkly skills` command outputs Markdown-formatted context about your Checkly project, describing monitoring capabilities and how to use them programmatically. **This context is designed to be discovered and consumed by AI agents and LLMs**, giving them the information they need to work with your monitoring setup.
1010

11-
You can also install [Checkly Skills as an agent skill](/integrations/ai/skills) to let your AI agent automatically discover and use the `checkly skills` command.
11+
You can also install [Checkly Skills as an agent skill](/ai/skills) to let your AI agent automatically discover and use the `checkly skills` command.
1212

1313
<Accordion title="Prerequisites">
1414
Before using `checkly skills`, ensure you have:
@@ -31,6 +31,7 @@ npx checkly skills <action> [resource]
3131

3232
| Action | Description |
3333
|--------|-------------|
34+
| `install` | Install [the Checkly agent skill (SKILL.md)](/ai/skills) into your project. |
3435
| `initialize` | Let your agent initialize [a new Checkly project](/constructs/project). |
3536
| `configure` | Let your agent configure [Checkly constructs](/constructs/overview). |
3637
| `investigate` | Access check status, analyze failures, and investigate errors. |

‎cli/overview.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ Checkly is designed to work with Agents, AI IDEs, and Copilots. You can use your
6464
Checks, Browser Checks and all other constructs.
6565

6666
<Columns cols={2}>
67-
<Card title="Checkly Skills" href="/integrations/ai/skills">
67+
<Card title="Checkly Skills" href="/ai/skills">
6868
Install Checkly Skills and let AI agents generate Checkly monitoring code for you.
6969
</Card>
70-
<Card title="Checkly Rules" href="/integrations/ai/rules">
70+
<Card title="Checkly Rules" href="/ai/rules">
7171
Include the Checkly Rules in your conversations to generate Checkly monitoring code for you.
7272
</Card>
7373
</Columns>

‎docs.json‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -341,16 +341,23 @@
341341
]
342342
},
343343
{
344-
"group": "Integrations",
344+
"group": "AI",
345345
"pages": [
346346
{
347-
"group": "AI Agents & Coding Assistants",
347+
"group": "Agent resources",
348348
"pages": [
349-
"integrations/ai/overview",
350-
"integrations/ai/skills",
351-
"integrations/ai/rules"
349+
"ai/overview",
350+
"ai/skills",
351+
"ai/markdown-access",
352+
"ai/llms-txt",
353+
"ai/rules"
352354
]
353-
},
355+
}
356+
]
357+
},
358+
{
359+
"group": "Integrations",
360+
"pages": [
354361
{
355362
"group": "Alerts & Notifications",
356363
"pages": [

‎guides/agentic-workflows.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Before your AI assistant can effectively configure Checkly monitoring, it needs
3131

3232
### Add the Checkly rules file
3333

34-
Download [the official Checkly rules file](/integrations/ai/overview) and add it to your project. This file contains instructions on project structure, CLI commands, links to documentation and code examples for all the different Checkly check types.
34+
Download [the official Checkly rules file](/ai/overview) and add it to your project. This file contains instructions on project structure, CLI commands, links to documentation and code examples for all the different Checkly check types.
3535

3636
```md checkly.rules.md
3737
# Checkly
@@ -498,4 +498,4 @@ As mentioned in the beginning: **Checkly is by definition AI-ready** without com
498498
- Test your monitoring configuration before deploying. Use `npx checkly test` to validate checks locally before pushing to production.
499499
- Your AI agent might deploy your monitoring when running in YOLO or `--skip-permissions` mode. Be aware of this risk and implement guard rails.
500500

501-
For complete documentation on AI integrations, see [the AI overview](/integrations/ai/overview).
501+
For complete documentation on AI integrations, see [the AI overview](/ai/overview).

‎sitemap-crawl.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,12 +187,15 @@ This file contains all valid URLs extracted from docs.json organized by director
187187
- /resolve/traces/instrumentation/java
188188
- /resolve/traces/instrumentation/dotnet
189189

190-
## Integrations
190+
## AI
191+
192+
- /ai/overview
193+
- /ai/skills
194+
- /ai/markdown-access
195+
- /ai/llms-txt
196+
- /ai/rules
191197

192-
### Integrations - AI
193-
- /integrations/ai/overview
194-
- /integrations/ai/skills
195-
- /integrations/ai/rules
198+
## Integrations
196199

197200
### Integrations - Alerts & Notifications
198201
- /integrations/alerts/discord

0 commit comments

Comments
 (0)