Skip to content

Commit 64756d7

Browse files
authored
feat: boilerplate for AI docs. (#1295)
* feat: boilerplate for AI docs. * feat: adds first AI docs [sc-00]
1 parent 06f659c commit 64756d7

File tree

9 files changed

+1177
-274
lines changed

9 files changed

+1177
-274
lines changed

package-lock.json

Lines changed: 1073 additions & 273 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"@babel/preset-env": "^7.26.0",
5959
"@babel/register": "7.25.9",
6060
"@playwright/test": "1.31.2",
61-
"checkly": "5.0.1",
61+
"checkly": "5.5.0",
6262
"eslint": "^8.50.0",
6363
"eslint-config-standard": "^17.1.0",
6464
"eslint-plugin-html": "^7.1.0",
252 KB
Loading
230 KB
Loading
137 KB
Loading

site/config.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ disqusShortname = "checkly"
7373
[[menu.platform]]
7474
name = "Traces"
7575
url = "/docs/traces-open-telemetry/"
76+
weight = 40
77+
78+
[[menu.platform]]
79+
name = "AI"
80+
url = "/docs/ai/"
7681
weight = 50
7782

7883
[[menu.resources]]

site/content/docs/ai/_index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: How Checkly uses AI - Checkly Docs
3+
displayTitle: How Checkly uses AI
4+
navTitle: How Checkly uses AI
5+
weight: 1
6+
slug: /
7+
menu:
8+
platform:
9+
parent: "AI"
10+
---
11+
12+
Checkly uses AI to enhance our monitoring and testing capabilities. Checkly's AI features are always opt-in. You can
13+
opt in on the [AI settings screen](https://app.checklyhq.com/settings/account/ai).
14+
15+
> During the beta phase, Enterprise customers need to enable the AI features in the [Lab settings screen](https://app.checklyhq.com/settings/account/labs) to use them.
16+
17+
We focus the use of AI on three following areas:
18+
19+
1. **Check creation**: use AI to quickly generate checks based making it quicker and easier to set up monitoring for new applications or features.
20+
2. **Check failure triage**: use AI to analyze check failures and provide insights into impacted users and features, helping teams quickly identify and resolve issues.
21+
3. **Check failure remediation**: use AI to propose remediation steps for check failures, reducing the time spent on troubleshooting and improving overall system reliability.
22+
23+
## Data Privacy and Security
24+
25+
All AI features are designed to operate on the data you provide or the data generated by your checks. This data is already
26+
stored in Checkly, and we do not send any additional data to third-party AI providers.
27+
28+
Any provided [environment secrets](https://www.checklyhq.com/docs/api-checks/variables/) are scrubbed before being sent to the AI provider.
29+
30+
We do not train any custom models on your data. Any data used by the AI features is processed in real-time and not stored for future use.
31+
To address further privacy concerns, you can bring your own AI model and provider to Checkly. For more information, see the section below on built-in and custom models.
32+
33+
## Built-in and Custom Models
34+
35+
By default, Checkly uses OpenAI's GPT-4.1 model for AI features. However, you can also bring your own model (BYOM) and provider to Checkly.
36+
To do this, you need to set up a custom AI provider in the [AI settings screen](https://app.checklyhq.com/settings/account/ai).
37+
38+
> The Bring Your Own Model (BYOM) feature is available for Enterprise customers only.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: AI assisted features in Checkly - Checkly Docs
3+
displayTitle: AI assisted Checkly features
4+
navTitle: AI assisted features
5+
weight: 2
6+
menu:
7+
platform:
8+
parent: "AI"
9+
---
10+
11+
Checkly AI is not one feature, but a set of features that use AI to enhance your monitoring and testing capabilities. Currently,
12+
you can use AI in the following parts of the product:
13+
14+
## Playwright Test Analysis
15+
16+
On each failed Playwright-powered check result, Checkly AI analyzes the traces, script code, screenshots and script code to provide you with a detailed analysis of the failure.
17+
This includes:
18+
19+
- **End-user impact**: Checkly AI analyzes the failure and provides you with a list of impacted users and features. The text used is generated by AI and can be enriched with organisation-specific domain knowledge using the **Tag description editor** the [AI settings screen](https://app.checklyhq.com/settings/account/ai).
20+
- **Step summary**: Checkly AI summarizes the steps in the check script, making it easier to understand what the check is doing and where it failed.
21+
- **Root cause**: Checkly AI analyzes the failure and provides you with a root cause analysis, helping you quickly remediate the issue.
22+
23+
![Playwright Test AI analysis](/docs/images/ai/pwt-test-analysis-example.png)
24+
25+
26+
## Tag Description Editor
27+
28+
Using the [Tag Description Editor](https://app.checklyhq.com/settings/account/ai), you can add custom descriptions to your tags. Checkly AI uses these descriptions to
29+
provide more context and insights into failures and the impact on user groups, features and applications.
30+
31+
This is very useful for organizations with specific domain knowledge and terminology embedded in their tags. For example,
32+
a tag like `feat:checkout` can be enriched with a description like "This tag is used for the checkout feature of our e-commerce application, which allows users to purchase products online."
33+
34+
![Tag description](/docs/images/ai/tag-description-example.png)
35+
36+
## Playwright Error Explainer
37+
38+
On each Playwright error, Checkly AI provides you with an error explanation. This includes:
39+
40+
- A general explanation of the error.
41+
- A suggestion on how to fix the error with a code snippet.
42+
- A (set of) link(s) to the Playwright documentation for the error.
43+
44+
![Playwright Test AI error explainer](/docs/images/ai/pwt-error-explainer-example.png)
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Using Checkly with AI IDEs and Copilots - Checkly Docs
3+
displayTitle: Use Checkly with AI IDEs & Copilots
4+
navTitle: Use Checkly with AI IDEs & Copilots
5+
weight: 3
6+
draft: true
7+
menu:
8+
platform:
9+
parent: "AI"
10+
---
11+
12+
## GitHub Copilot
13+
14+
## Cursor
15+
16+

0 commit comments

Comments
 (0)