Skip to content

Commit 196ab91

Browse files
tnolettnolet
authored
feat: updates copy, adds links and cards. Makes rules file broader but clearer. (#1308)
1 parent 8902c94 commit 196ab91

File tree

11 files changed

+279
-428
lines changed

11 files changed

+279
-428
lines changed

‎site/config.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,12 @@ disqusShortname = "checkly"
223223
url = "https://developers.checklyhq.com"
224224
weight = 200
225225

226+
[[menu.reference]]
227+
name = "llms.txt"
228+
url = "/llms.txt"
229+
weight = 210
230+
231+
226232
[[menu.learn_playwright]]
227233
name = "Getting started"
228234
pre = "/learn/icons/playwright-logo.svg"

‎site/content/_shared/ai-ide-copilot-cards.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
sitemapExclude: true
3+
---
4+
<div class="cards-list">
5+
{{< doc-card
6+
class="three-column-card"
7+
headerTag="h3"
8+
title="GitHub Copilot"
9+
img="/docs/images/icons/github-copilot-icon.svg"
10+
description="Download the Checkly instructions file and let copilot generate Checkly CLI code for you."
11+
link="/docs/ai/use-checkly-with-ai-ide/#github-copilot"
12+
>}}
13+
{{< doc-card
14+
class="three-column-card"
15+
headerTag="h3"
16+
title="Cursor"
17+
img="/docs/images/icons/cursor-icon.svg"
18+
description="Download the Checkly `.mdc` rules file and let Cursor generate Checkly CLI code for you."
19+
link="/docs/ai/use-checkly-with-ai-ide/#cursor"
20+
>}}
21+
{{< doc-card
22+
class="three-column-card"
23+
headerTag="h3"
24+
title="Windsurf"
25+
img="/docs/images/icons/windsurf-icon.svg"
26+
description="Download the Checkly rules file and let Windsurf generate Checkly CLI code for you."
27+
link="/docs/ai/use-checkly-with-ai-ide/#windsurf"
28+
>}}
29+
</div>

‎site/content/docs/_index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ link="/docs/terraform-provider/"
3434
</div>
3535
3636

37+
## Get started using AI IDEs and Copilots
38+
39+
Checkly is designed to work with AI IDEs and Copilots. You can use your preferred provider to generate code for API
40+
Checks, Browser Checks and all other constructs.
41+
42+
{{< markdownpartial "/_shared/ai-ide-copilot-cards.md" >}}
43+
3744
## Get started using the web UI
3845

3946
Not quite ready to start your monitoring as code journey? No problem. Get started using just the web UI and you'll be
@@ -91,7 +98,7 @@ monitoring in minutes.
9198
headerTag="h3"
9299
title="Set up alert channels"
93100
img="/docs/images/icons/alerting.svg"
94-
description="Get notified about outages, broken transactions or slow downs in your webapps and APIs. Connect to one of our many integrations like Slack, Pagerduty and Discord."
101+
description="Get notified about outages or slow downs in your webapps and APIs. Connect to one of our many integrations like Slack and Pagerduty."
95102
link="/docs/alerting"
96103
>}}
97104
</div>

‎site/content/docs/ai/use-checkly-with-ai-ide.md

Lines changed: 64 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Using Checkly with AI IDEs and Copilots - Checkly Docs
33
displayTitle: Use Checkly with AI IDEs & Copilots
44
navTitle: Use Checkly with AI IDEs & Copilots
55
weight: 3
6-
beta: true
76
menu:
87
platform:
98
parent: "AI"
@@ -19,59 +18,100 @@ Make sure to index the following url:
1918
https://checklyhq.com/docs/
2019
```
2120

22-
- [Cursor](https://docs.cursor.com/context/@-symbols/@-docs)
21+
- [Referencing @docs with Cursor](https://docs.cursor.com/context/@-symbols/@-docs)
2322

2423
At the time of writing this unfortunately no other IDE supports this kind of context enrichment.
2524

26-
## Custom Rules
25+
## Plain text docs
2726

28-
We prepared a first set of ai rules which you can use to teach your AI IDE of choice on how to generate code for Checkly.
27+
Every page on our docs site is accessible as a plain markdown file by appending `index.md` to the url, e.g.
28+
[https://www.checklyhq.com/docs/cli/constructs-reference/index.md](https://www.checklyhq.com/docs/cli/constructs-reference/index.md).
2929

30-
Go into the root of your IDEs workspace and download the rules according to your IDEs config parameters.
30+
There is also an [`/llms.txt`](https://www.checklyhq.com/llms.txt) at the root of our site which contains all the URLs
31+
of our docs pages in plain text format. You can use this file to index our docs in your AI IDE of choice.
32+
33+
## Custom Rules
3134

35+
We prepared a first set of AI rules which you can use to teach your AI IDE of choice on how to generate code for Checkly.
36+
Go into the root of your IDEs workspace and download the rules according to your IDEs config parameters.
3237
When asking questions about Checkly manually add the download rules files to your prompt.
3338

3439
### GitHub Copilot
3540

36-
Windows
41+
{{< tabs "GH Copilot" >}}
3742

38-
```powershell
39-
New-Item -ItemType Directory -Path ".github\instructions" -Force
40-
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/docs/ai/checkly.rules.md" -OutFile ".github\instructions\checkly-api-check.md"
43+
{{< tab "Mac and Linux" >}}
44+
45+
```bash
46+
mkdir -p .github && curl -o .github/copilot-instructions.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
4147
```
4248

43-
Mac and Linux
49+
{{< /tab >}}
50+
51+
{{< tab "Windows" >}}
4452

4553
```bash
46-
mkdir -p .github/instructions && curl -o .github/instructions/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
54+
New-Item -ItemType Directory -Path ".github\instructions" -Force
55+
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/docs/ai/checkly.rules.md" -OutFile ".github\copilot-instructions.md"
4756
```
4857

58+
{{< /tab >}}
59+
60+
{{< /tabs >}}
61+
62+
You can ask Copilot to install the `checkly` NPM package and generate code for API Checks, Browser checks, Multistep checks
63+
and all other constructs.
64+
65+
4966
### Cursor
5067

51-
Windows
68+
{{< tabs "Cursor" >}}
5269

53-
```powershell
54-
New-Item -ItemType Directory -Path ".cursor\rules" -Force
55-
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".cursor\rules\checkly-api-check.mdc"
70+
{{< tab "Mac and Linux" >}}
71+
72+
```bash
73+
mkdir -p .cursor/rules && curl -o .cursor/rules/checkly.mdc "https://www.checklyhq.com/docs/ai/checkly.rules.md"
5674
```
5775

58-
Mac and Linux
76+
Now make sure to add the new `checkly.mdc` file to your context.
77+
78+
You can now ask Cursor to install the `checkly` NPM package and generate code for API Checks, Browser checks, Multistep checks
79+
and all other constructs. Make sure to use the `checkly.mdc` file as context for your questions.
5980

81+
{{< /tab >}}
82+
83+
{{< tab "Windows" >}}
6084
```bash
61-
mkdir -p .cursor/rules && curl -o .cursor/rules/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
85+
New-Item -ItemType Directory -Path ".cursor\rules" -Force
86+
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".cursor\rules\checkly.mdc"
6287
```
88+
{{< /tab >}}
6389

64-
## Windsurf
90+
{{< /tabs >}}
6591

66-
Windows
92+
You can now reference the `checkly.mdc` using `@checkly.mdc` file in your Cursor chats and ask it to generate code for
93+
API Checks, Browser checks, Multistep checks and all other constructs.
6794

68-
```powershell
69-
New-Item -ItemType Directory -Path ".windsurf\rules" -Force
70-
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly-api-check.md" -OutFile ".windsurf\rules\checkly-api-check.md"
95+
### Windsurf
96+
97+
{{< tabs "Windsurf" >}}
98+
99+
{{< tab "Mac and Linux" >}}
100+
101+
```bash
102+
mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
71103
```
104+
{{< /tab >}}
72105

73-
Mac and Linux
106+
{{< tab "Windows" >}}
74107

75108
```bash
76-
mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
109+
New-Item -ItemType Directory -Path ".windsurf\rules" -Force
110+
Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".windsurf\rules\checkly.md"
77111
```
112+
{{< /tab >}}
113+
114+
{{< /tabs >}}
115+
116+
You can now reference the `checkly.md` using `@checkly.md` file in your WindSurf chats and ask it to generate code for
117+
API Checks, Browser checks, Multistep checks and all other constructs.

‎site/content/docs/cli/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ Open up [your Checkly dashboard](https://app.checklyhq.com) and you should see y
6262

6363
For a custom installation check out [our installation docs](/docs/cli/installation/)
6464

65+
## Using AI IDEs and Copilots
66+
67+
Checkly is designed to work with AI IDEs and Copilots. You can use your preferred provider to generate code for API
68+
Checks, Browser Checks and all other constructs.
69+
70+
{{< markdownpartial "/_shared/ai-ide-copilot-cards.md" >}}
71+
6572
## Integrating with CI/CD
6673

6774
After kicking the tires, you should delegate the testing and deploying of your checks to your CI/CD pipeline. Check our

‎site/content/docs/cli/constructs-reference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,11 @@ See the [`TcpAssertionBuilder` reference](#tcpassertionbuilder).
363363

364364
### `TcpAssertionBuilder`
365365

366-
To define `assertions` for the `request` of an `TcpCheck` you should use the `TcpAssertionBuilder`.
366+
To define `assertions` for the `request` of an `TcpCheck` you should use the `TcpAssertionBuilder`. The `TcpAssertionBuilder`
367+
has the following properties:
368+
369+
- `responseTime()`: Assert the total response time of the TCP request.
370+
- `responseData()`: Assert the value in the response data.
367371

368372
Here are some examples:
369373

0 commit comments

Comments
 (0)