Skip to content

docs: update AI section, skills, and add markdown-access and llms-txt pages #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefanjudis merged 12 commits into from
Mar 25, 2026
Merged

docs: update AI section, skills, and add markdown-access and llms-txt pages #229

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2f82d4f
docs: add AI section with markdown-access and llms-txt pages
stefanjudis Mar 25, 2026
52c053d
docs: add skills install action to CLI reference
stefanjudis Mar 25, 2026
f62548d
Update snippets/agent-example.mdx
stefanjudis Mar 25, 2026
399ec7a
Update snippets/agent-example.mdx
stefanjudis Mar 25, 2026
b4e1466
Update snippets/agent-example.mdx
stefanjudis Mar 25, 2026
292c831
Update ai/markdown-access.mdx
stefanjudis Mar 25, 2026
f23b7ac
Update ai/markdown-access.mdx
stefanjudis Mar 25, 2026
2bdfb2b
docs: update sitemap-crawl with AI as its own section
stefanjudis Mar 25, 2026
930dce1
docs: add alternative skills CLI install command
stefanjudis Mar 25, 2026
94ae9f9
docs: fix skills CLI add command shorthand
stefanjudis Mar 25, 2026
3cbcd9a
Apply suggestion from @guolau
stefanjudis Mar 25, 2026
9068db7
docs: streamline markdown access page
stefanjudis Mar 25, 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
41 changes: 41 additions & 0 deletions ai/llms-txt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: 'llms.txt'
description: 'Use the Checkly llms.txt file to discover and crawl all available documentation pages as markdown.'
sidebarTitle: 'llms.txt'
---

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.

```txt llms.txt (first 15 lines)
# Checkly Docs

## Docs

- [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
- [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
- [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
- [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.
- [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
- [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.
- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members
- [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
- [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
- [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
- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly
```

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.

```bash
# Fetch the llms.txt index
curl https://www.checklyhq.com/llms.txt

# Fetch a specific page from the index
curl https://checklyhq.com/docs/browser-checks.md
Comment thread
stefanjudis marked this conversation as resolved.
Outdated
```

## Additional resources

- [Markdown Access](/ai/markdown-access)
- [Checkly Skills](/ai/skills)
- [Checkly Rules](/ai/rules)
Comment thread
stefanjudis marked this conversation as resolved.
87 changes: 87 additions & 0 deletions ai/markdown-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: 'Markdown Access'
description: 'Access Checkly documentation as markdown to use with AI assistants and coding agents.'
sidebarTitle: 'Markdown Access'
---

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.

## .md endpoints

Append `.md` to any documentation URL to get the markdown version of that page.

**Example:**

- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/`
- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md`

The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables.

```bash
# Fetch documentation content with curl
curl https://www.checklyhq.com/docs/what-is-checkly.md

# Pipe directly to your clipboard
curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy
```

## Content negotiation

You can also request markdown by setting the `Accept` header to `text/markdown`:

```bash
curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/
```

This is useful when integrating with tools or scripts that set request headers programmatically.

<Tip>
Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/).
Comment thread
stefanjudis marked this conversation as resolved.
</Tip>

## Copy as Markdown button

Every documentation page includes a **Copy as Markdown** button at the top of the page sidebar. Click it to copy the full page content as markdown to your clipboard.

This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context.

## Feeding documentation to AI assistants

Here are some patterns for using Checkly documentation with AI tools:
Copy link
Copy Markdown
Contributor

@guolau guolau Mar 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the best way to give agents context? I'd assume modern agents can query the URL directly, which might be easier than having to copy a page's MD? (Asking since I am mostly curious and not too familiar with how this stuff works 🙂)

Copy link
Copy Markdown
Collaborator Author

@stefanjudis stefanjudis Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great call. removed rephrased. :)


### Single page context

When you need help with a specific feature, copy that page's markdown and include it in your prompt:

```text
Here is the Checkly Browser Checks documentation:

[paste markdown content]

Based on this, how do I set up a browser check with a custom user agent?
```

### Multiple page context

For complex tasks, combine multiple relevant pages:

```text
I need to set up monitoring for my API. Here is the relevant documentation:

## API Checks
[paste api-checks.md]

## Alerting
[paste alerting.md]

Help me set this up step by step.
```

### Built-in agent documentation

The [`checkly skills` command](/cli/checkly-skills) provides documentation optimized for your agent. Use it with [the Checkly Skills](/ai/skills) to see the best results.

## Additional resources

- [Checkly Skills](/ai/skills)
- [Checkly Rules](/ai/rules)
Comment thread
stefanjudis marked this conversation as resolved.
10 changes: 5 additions & 5 deletions integrations/ai/overview.mdx → ai/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ Provide the necessary Checkly context and let your AI agent of choice do the res

## Add Checkly context to your AI agent conversation

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.
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.

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

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

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.

**With Monitoring as Code, Checkly already provides a native way to control your monitoring infrastructure via code and the command line.**
**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.**

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.
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.

<Tip>
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.
Expand Down
6 changes: 5 additions & 1 deletion integrations/ai/rules.mdx → ai/rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
title: 'Checkly Rules'
description: 'Add Checkly rules files to your AI agent to provide monitoring context for your coding workflow.'
sidebarTitle: 'Checkly Rules'
sidebarTitle: 'Rules'
---

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

<Warning>
Use the Checkly Skills instead if your coding agents supports [Agent Skills](https://agentskills.io).
</Warning>

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.

Once the Checkly rules are included in your AI context window, your agent can effectively assist you in managing your monitoring setup.
Expand Down
9 changes: 6 additions & 3 deletions integrations/ai/skills.mdx → ai/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
---
title: 'Checkly Skills'
description: 'Install Checkly skills to give your AI agent on-demand monitoring context and capabilities.'
sidebarTitle: 'Checkly Skills'
sidebarTitle: 'Skills'
---

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.

[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.

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:
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:

```bash
npx checkly skills install

# or if you prefer the `skills` CLI
npx skills add checkly/checkly-cli
```

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

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.
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.

## Additional resources

Expand Down
3 changes: 2 additions & 1 deletion cli/checkly-skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebarTitle: 'checkly skills'

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.

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.
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.

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

| Action | Description |
|--------|-------------|
| `install` | Install [the Checkly agent skill (SKILL.md)](/ai/skills) into your project. |
| `initialize` | Let your agent initialize [a new Checkly project](/constructs/project). |
| `configure` | Let your agent configure [Checkly constructs](/constructs/overview). |
| `investigate` | Access check status, analyze failures, and investigate errors. |
Expand Down
4 changes: 2 additions & 2 deletions cli/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ Checkly is designed to work with Agents, AI IDEs, and Copilots. You can use your
Checks, Browser Checks and all other constructs.

<Columns cols={2}>
<Card title="Checkly Skills" href="/integrations/ai/skills">
<Card title="Checkly Skills" href="/ai/skills">
Install Checkly Skills and let AI agents generate Checkly monitoring code for you.
</Card>
<Card title="Checkly Rules" href="/integrations/ai/rules">
<Card title="Checkly Rules" href="/ai/rules">
Include the Checkly Rules in your conversations to generate Checkly monitoring code for you.
</Card>
</Columns>
Expand Down
19 changes: 13 additions & 6 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,16 +341,23 @@
]
},
{
"group": "Integrations",
"group": "AI",
"pages": [
{
"group": "AI Agents & Coding Assistants",
"group": "Agent resources",
"pages": [
"integrations/ai/overview",
"integrations/ai/skills",
"integrations/ai/rules"
"ai/overview",
"ai/skills",
"ai/markdown-access",
"ai/llms-txt",
"ai/rules"
]
},
}
]
},
{
"group": "Integrations",
"pages": [
{
"group": "Alerts & Notifications",
"pages": [
Expand Down
4 changes: 2 additions & 2 deletions guides/agentic-workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before your AI assistant can effectively configure Checkly monitoring, it needs

### Add the Checkly rules file

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.
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.

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

For complete documentation on AI integrations, see [the AI overview](/integrations/ai/overview).
For complete documentation on AI integrations, see [the AI overview](/ai/overview).
13 changes: 8 additions & 5 deletions sitemap-crawl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Checkly Docs Sitemap

Check warning on line 1 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L1 

'Checkly Docs Sitemap' should use sentence-style capitalization.

Check warning on line 1 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L1 

Did you really mean 'Checkly'?

This file contains all valid URLs extracted from docs.json organized by directory structure.

## Root Pages

Check warning on line 5 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L5 

'Root Pages' should use sentence-style capitalization.
- /what-is-checkly

Check warning on line 6 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L6 

Try to avoid using 'is'.

## Quickstarts

Check warning on line 8 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L8 

Did you really mean 'Quickstarts'?
- /quickstarts/url-monitor

Check warning on line 9 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L9 

Use 'URL' instead of 'url'.

Check warning on line 9 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L9 

'monitor' is too wordy.
- /quickstarts/browser-check
- /quickstarts/api-check
- /quickstarts/multistep-check
- /quickstarts/heartbeat-monitor

Check warning on line 13 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L13 

'monitor' is too wordy.
- /quickstarts/tcp-monitor

Check warning on line 14 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L14 

'monitor' is too wordy.

## Concepts
- /concepts/checks
Expand All @@ -29,7 +29,7 @@
- /platform/network-diagnostic-tools
- /platform/managing-false-positives

### Platform - Private Locations

Check warning on line 32 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L32 

'Platform - Private Locations' should use sentence-style capitalization.
- /platform/private-locations/overview
- /platform/private-locations/quick-start
- /platform/private-locations/use-cases
Expand All @@ -39,54 +39,54 @@
- /platform/private-locations/proxy-setup
- /platform/private-locations/scaling-redundancy

### Platform - Reporting

Check warning on line 42 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L42 

'Platform - Reporting' should use sentence-style capitalization.
- /platform/reporting/overview
- /platform/reporting/analytics-api

### Platform - Runtimes

Check warning on line 46 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L46 

'Platform - Runtimes' should use sentence-style capitalization.

Check warning on line 46 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L46 

Did you really mean 'Runtimes'?
- /platform/runtimes/overview
- /platform/runtimes/runtime-specification
- /platform/runtimes/dependencies

## Admin
- /admin/creating-api-key

Check warning on line 52 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L52 

Use 'administrator' instead of 'admin'.
- /admin/changing-your-email-password

Check warning on line 53 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L53 

Use 'administrator' instead of 'admin'.
- /admin/data-storage

Check warning on line 54 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L54 

Use 'administrator' instead of 'admin'.
- /admin/ip-information

Check warning on line 55 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L55 

Use 'administrator' instead of 'admin'.

### Admin - Team Management

Check warning on line 57 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L57 

'Admin - Team Management' should use sentence-style capitalization.
- /admin/team-management/overview

Check warning on line 58 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L58 

Use 'administrator' instead of 'admin'.
- /admin/team-management/adding-team-members

Check warning on line 59 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L59 

Use 'administrator' instead of 'admin'.
- /admin/team-management/microsoft-azure-ad

Check warning on line 60 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L60 

Use 'administrator' instead of 'admin'.
- /admin/team-management/multi-factor-authentication

Check warning on line 61 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L61 

Use 'administrator' instead of 'admin'.
- /admin/team-management/saml

Check warning on line 62 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L62 

Use 'administrator' instead of 'admin'.
- /admin/team-management/single-sign-on

Check warning on line 63 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L63 

Use 'administrator' instead of 'admin'.

Check warning on line 63 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L63 

Use 'single sign-on' instead of 'sign-on'.

## Detect
- /detect/overview

### Detect - Uptime Monitoring

Check warning on line 68 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L68 

'Detect - Uptime Monitoring' should use sentence-style capitalization.
- /detect/uptime-monitoring/overview

#### Detect - URL Monitors

Check warning on line 71 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L71 

'Detect - URL Monitors' should use sentence-style capitalization.
- /detect/uptime-monitoring/url-monitors/overview

Check warning on line 72 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L72 

Use 'URL' instead of 'url'.
- /detect/uptime-monitoring/url-monitors/configuration

Check warning on line 73 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L73 

Use 'URL' instead of 'url'.
- /detect/uptime-monitoring/url-monitors/creating-your-first-url-monitor

Check warning on line 74 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L74 

Use 'URL' instead of 'url'.

Check warning on line 74 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L74 

Use 'URL' instead of 'url'.

Check warning on line 74 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L74 

'monitor' is too wordy.

#### Detect - Heartbeat Monitors

Check warning on line 76 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L76 

'Detect - Heartbeat Monitors' should use sentence-style capitalization.
- /detect/uptime-monitoring/heartbeat-monitors/overview
- /detect/uptime-monitoring/heartbeat-monitors/creating-your-first-heartbeat-monitor

Check warning on line 78 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L78 

'monitor' is too wordy.
- /detect/uptime-monitoring/heartbeat-monitors/examples

#### Detect - TCP Monitors

Check warning on line 81 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L81 

'Detect - TCP Monitors' should use sentence-style capitalization.
- /detect/uptime-monitoring/tcp-monitors/overview
- /detect/uptime-monitoring/tcp-monitors/configuration
- /detect/uptime-monitoring/tcp-monitors/creating-your-first-tcp-monitor

Check warning on line 84 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L84 

'monitor' is too wordy.

### Detect - Synthetic Monitoring

Check warning on line 86 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L86 

'Detect - Synthetic Monitoring' should use sentence-style capitalization.
- /detect/synthetic-monitoring/overview

#### Detect - API Checks

Check warning on line 89 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L89 

'Detect - API Checks' should use sentence-style capitalization.
- /detect/synthetic-monitoring/api-checks/overview
- /detect/synthetic-monitoring/api-checks/creating-your-first-api-check
- /detect/synthetic-monitoring/api-checks/api-structure
Expand All @@ -96,7 +96,7 @@
- /detect/synthetic-monitoring/api-checks/snippets
- /detect/synthetic-monitoring/api-checks/troubleshooting

#### Detect - Multistep Checks

Check warning on line 99 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L99 

'Detect - Multistep Checks' should use sentence-style capitalization.

Check warning on line 99 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L99 

Did you really mean 'Multistep'?
- /detect/synthetic-monitoring/multistep-checks/overview
- /detect/synthetic-monitoring/multistep-checks/creating-your-first-multistep-check
- /detect/synthetic-monitoring/multistep-checks/multistep-structure
Expand All @@ -105,7 +105,7 @@
- /detect/synthetic-monitoring/multistep-checks/websockets
- /detect/synthetic-monitoring/multistep-checks/examples

#### Detect - Browser Checks

Check warning on line 108 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L108 

'Detect - Browser Checks' should use sentence-style capitalization.
- /detect/synthetic-monitoring/browser-checks/overview
- /detect/synthetic-monitoring/browser-checks/creating-a-browser-check
- /detect/synthetic-monitoring/browser-checks/mac-structure
Expand All @@ -117,14 +117,14 @@
- /detect/synthetic-monitoring/browser-checks/timeouts
- /detect/synthetic-monitoring/browser-checks/troubleshooting

#### Detect - Playwright Checks Suite

Check warning on line 120 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L120 

'Detect - Playwright Checks Suite' should use sentence-style capitalization.
- /detect/synthetic-monitoring/playwright-checks/overview
- /detect/synthetic-monitoring/playwright-checks/quickstart
- /detect/synthetic-monitoring/playwright-checks/reference
- /detect/synthetic-monitoring/playwright-checks/add-to-group
- /detect/synthetic-monitoring/playwright-checks/custom-dependencies

### Detect - Testing

Check warning on line 127 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L127 

'Detect - Testing' should use sentence-style capitalization.
- /detect/testing/overview
- /detect/testing/creating-your-first-test
- /detect/testing/using-env-variables
Expand All @@ -132,50 +132,50 @@
## Communicate
- /communicate/overview

### Communicate - Alerts

Check warning on line 135 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L135 

'Communicate - Alerts' should use sentence-style capitalization.
- /communicate/alerts/overview
- /communicate/alerts/configuration
- /communicate/alerts/channels
- /communicate/alerts/retries
- /communicate/alerts/ssl-expiration

Check warning on line 140 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L140 

'expiration' is too wordy.
- /communicate/alerts/notification-log

### Communicate - Status Pages

Check warning on line 143 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L143 

'Communicate - Status Pages' should use sentence-style capitalization.
- /communicate/status-pages/overview
- /communicate/status-pages/creating-a-status-page
- /communicate/status-pages/customization
- /communicate/status-pages/incidents

### Communicate - Dashboards

Check warning on line 149 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L149 

'Communicate - Dashboards' should use sentence-style capitalization.
- /communicate/dashboards/overview
- /communicate/dashboards/configuration
- /communicate/dashboards/custom-css
- /communicate/dashboards/incidents

### Communicate - Maintenance Windows

Check warning on line 155 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L155 

'Communicate - Maintenance Windows' should use sentence-style capitalization.
- /communicate/maintenance-windows/overview

## Resolve
- /resolve/overview
- /resolve/rocky-ai/overview

### Resolve - Traces

Check warning on line 162 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L162 

'Resolve - Traces' should use sentence-style capitalization.
- /resolve/traces/overview
- /resolve/traces/how-it-works

#### Resolve - Traces - Importing

Check warning on line 166 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L166 

'Resolve - Traces - Importing' should use sentence-style capitalization.
- /resolve/traces/import/overview
- /resolve/traces/import/open-telemetry
- /resolve/traces/import/missing-spans
- /resolve/traces/import/https-grpc

#### Resolve - Traces - Exporting

Check warning on line 172 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L172 

'Resolve - Traces - Exporting' should use sentence-style capitalization.
- /resolve/traces/export/grafana-tempo
- /resolve/traces/export/honeycomb
- /resolve/traces/export/new-relic
- /resolve/traces/export/dash0

#### Resolve - Traces - Instrumentation

Check warning on line 178 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L178 

'Resolve - Traces - Instrumentation' should use sentence-style capitalization.
- /resolve/traces/instrumentation/nextjs
- /resolve/traces/instrumentation/nodejs
- /resolve/traces/instrumentation/express
Expand All @@ -187,14 +187,17 @@
- /resolve/traces/instrumentation/java
- /resolve/traces/instrumentation/dotnet

## Integrations
## AI

- /ai/overview
- /ai/skills
- /ai/markdown-access
- /ai/llms-txt
- /ai/rules

### Integrations - AI
- /integrations/ai/overview
- /integrations/ai/skills
- /integrations/ai/rules
## Integrations

### Integrations - Alerts & Notifications

Check warning on line 200 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L200 

'Integrations - Alerts & Notifications' should use sentence-style capitalization.
- /integrations/alerts/discord
- /integrations/alerts/email
- /integrations/alerts/gitlab_alerts
Expand All @@ -207,7 +210,7 @@
- /integrations/alerts/telegram
- /integrations/alerts/webhooks

### Integrations - Incident Management

Check warning on line 213 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L213 

'Integrations - Incident Management' should use sentence-style capitalization.
- /integrations/incident-management/firehydrant
- /integrations/incident-management/pagerduty
- /integrations/incident-management/opsgenie
Expand All @@ -221,23 +224,23 @@
- /integrations/ci-cd/gitlab/overview
- /integrations/ci-cd/jenkins/overview

#### Integrations - GitHub

Check warning on line 227 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L227 

'Integrations - GitHub' should use sentence-style capitalization.
- /integrations/ci-cd/github/actions
- /integrations/ci-cd/github/deployments

#### Integrations - Vercel

Check warning on line 231 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L231 

'Integrations - Vercel' should use sentence-style capitalization.

Check warning on line 231 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L231 

Did you really mean 'Vercel'?
- /integrations/ci-cd/vercel/overview
- /integrations/ci-cd/vercel/deployment-protection
- /integrations/ci-cd/vercel/managing-plan

### Integrations - Observability

Check warning on line 236 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L236 

'Integrations - Observability' should use sentence-style capitalization.
- /integrations/observability/prometheus
- /integrations/observability/prometheus-v2
- /integrations/observability/coralogix

### Integrations - Infrastructure as Code

Check warning on line 241 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L241 

'Integrations - Infrastructure as Code' should use sentence-style capitalization.

#### Integrations - Terraform

Check warning on line 243 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L243 

'Integrations - Terraform' should use sentence-style capitalization.
- /integrations/iac/terraform/overview
- /integrations/iac/terraform/alerting
- /integrations/iac/terraform/maintenance-windows
Expand All @@ -248,7 +251,7 @@
- /integrations/iac/terraform/snippets-variables
- /integrations/iac/terraform/troubleshooting

#### Integrations - Pulumi

Check warning on line 254 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L254 

'Integrations - Pulumi' should use sentence-style capitalization.

Check warning on line 254 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L254 

Did you really mean 'Pulumi'?
- /integrations/iac/pulumi/overview
- /integrations/iac/pulumi/best-practices
- /integrations/iac/pulumi/setup
Expand All @@ -259,10 +262,10 @@
- /constructs/quickstart
- /constructs/including-checks

### Constructs - DETECT

Check warning on line 265 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L265 

'Constructs - DETECT' should use sentence-style capitalization.
- /constructs/url-monitor

Check warning on line 266 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L266 

Use 'URL' instead of 'url'.

Check warning on line 266 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L266 

'monitor' is too wordy.
- /constructs/tcp-monitor

Check warning on line 267 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L267 

'monitor' is too wordy.
- /constructs/heartbeat-monitor

Check warning on line 268 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L268 

'monitor' is too wordy.
- /constructs/api-check
- /constructs/multistep-check
- /constructs/browser-check
Expand All @@ -274,7 +277,7 @@
- /constructs/dashboard
- /constructs/maintenance-window

#### Constructs - Alert Channels

Check warning on line 280 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L280 

'Constructs - Alert Channels' should use sentence-style capitalization.
- /constructs/email-alert-channel
- /constructs/sms-alert-channel
- /constructs/phone-call-alert-channel
Expand All @@ -282,71 +285,71 @@
- /constructs/msteams-alert-channel
- /constructs/webhook-alert-channel

#### Constructs - Status Pages

Check warning on line 288 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L288 

'Constructs - Status Pages' should use sentence-style capitalization.
- /constructs/status-page
- /constructs/status-page-service

### Constructs - Project & Configuration

Check warning on line 292 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L292 

'Constructs - Project & Configuration' should use sentence-style capitalization.
- /constructs/project
- /constructs/check-group-v2
- /constructs/check-group

## CLI

Check warning on line 297 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L297 

Use 'command-line tool' instead of 'CLI'.
- /cli/overview
- /cli/authentication
- /cli/basic-workflow
- /cli/environment-variables
- /cli/importing

### CLI Commands

Check warning on line 304 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L304 

Use 'command-line tool' instead of 'CLI'.

Check warning on line 304 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L304 

'CLI Commands' should use sentence-style capitalization.
- /cli/checkly-deploy

Check warning on line 305 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L305 

'cli/checkly-deploy' doesn't need a hyphen.
- /cli/checkly-destroy

Check warning on line 306 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L306 

'cli/checkly-destroy' doesn't need a hyphen.

Check warning on line 306 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L306 

Be careful with 'destroy', it's profane in some cases.
- /cli/checkly-env

Check warning on line 307 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L307 

'cli/checkly-env' doesn't need a hyphen.
- /cli/checkly-import

Check warning on line 308 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L308 

'cli/checkly-import' doesn't need a hyphen.
- /cli/checkly-login

Check warning on line 309 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L309 

'cli/checkly-login' doesn't need a hyphen.
- /cli/checkly-logout

Check warning on line 310 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L310 

'cli/checkly-logout' doesn't need a hyphen.
- /cli/checkly-pw-test

Check warning on line 311 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L311 

'cli/checkly-pw' doesn't need a hyphen.
- /cli/checkly-runtimes

Check warning on line 312 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L312 

'cli/checkly-runtimes' doesn't need a hyphen.
- /cli/checkly-switch

Check warning on line 313 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L313 

'cli/checkly-switch' doesn't need a hyphen.
- /cli/checkly-sync-playwright

Check warning on line 314 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L314 

'cli/checkly-sync' doesn't need a hyphen.
- /cli/checkly-test

Check warning on line 315 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L315 

'cli/checkly-test' doesn't need a hyphen.
- /cli/checkly-trigger

Check warning on line 316 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L316 

'cli/checkly-trigger' doesn't need a hyphen.
- /cli/checkly-whoami

Check warning on line 317 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L317 

'cli/checkly-whoami' doesn't need a hyphen.

## API Reference

Check warning on line 319 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L319 

'API Reference' should use sentence-style capitalization.

### API - Platform

Check warning on line 321 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L321 

'API - Platform' should use sentence-style capitalization.
- /api-reference/authentication

#### API - Accounts

Check warning on line 324 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L324 

'API - Accounts' should use sentence-style capitalization.
- /api-reference/accounts/list
- /api-reference/accounts/get
- /api-reference/accounts/me

Check warning on line 327 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L327 

Avoid first-person pronouns such as 'me'.

#### API - Analytics

Check warning on line 329 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L329 

'API - Analytics' should use sentence-style capitalization.
- /api-reference/analytics/metrics
- /api-reference/analytics/api-checks
- /api-reference/analytics/browser-checks
- /api-reference/analytics/heartbeat-checks
- /api-reference/analytics/multistep-checks
- /api-reference/analytics/tcp-checks
- /api-reference/analytics/url-monitors

Check warning on line 336 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L336 

Use 'URL' instead of 'url'.

#### API - Environment Variables

Check warning on line 338 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L338 

'API - Environment Variables' should use sentence-style capitalization.
- /api-reference/environment-variables/list
- /api-reference/environment-variables/get
- /api-reference/environment-variables/create
- /api-reference/environment-variables/update
- /api-reference/environment-variables/delete

#### API - Locations

Check warning on line 345 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L345 

'API - Locations' should use sentence-style capitalization.
- /api-reference/locations/list

#### API - Runtimes

Check warning on line 348 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L348 

'API - Runtimes' should use sentence-style capitalization.

Check warning on line 348 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L348 

Did you really mean 'Runtimes'?
- /api-reference/runtimes/list
- /api-reference/runtimes/get

#### API - Static IPs

Check warning on line 352 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L352 

'API - Static IPs' should use sentence-style capitalization.

Check warning on line 352 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L352 

Did you really mean 'IPs'?
- /api-reference/static-ips/list
- /api-reference/static-ips/by-region
- /api-reference/static-ips/text-format
Expand All @@ -354,19 +357,19 @@
- /api-reference/static-ips/ipv6-by-region
- /api-reference/static-ips/ipv6-text-format

#### API - Reporting

Check warning on line 360 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L360 

'API - Reporting' should use sentence-style capitalization.
- /api-reference/reporting/generate

#### API - Snippets

Check warning on line 363 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L363 

'API - Snippets' should use sentence-style capitalization.
- /api-reference/snippets/list
- /api-reference/snippets/get
- /api-reference/snippets/create
- /api-reference/snippets/update
- /api-reference/snippets/delete

### API - Detect

Check warning on line 370 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L370 

'API - Detect' should use sentence-style capitalization.

#### API - Checks

Check warning on line 372 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L372 

'API - Checks' should use sentence-style capitalization.
- /api-reference/checks/list
- /api-reference/checks/get
- /api-reference/checks/update
Expand All @@ -383,10 +386,10 @@
- /api-reference/checks/tcp-get
- /api-reference/checks/tcp-update
- /api-reference/checks/tcp-delete
- /api-reference/checks/url-create

Check warning on line 389 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L389 

Use 'URL' instead of 'url'.
- /api-reference/checks/url-get

Check warning on line 390 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L390 

Use 'URL' instead of 'url'.
- /api-reference/checks/url-update

Check warning on line 391 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L391 

Use 'URL' instead of 'url'.
- /api-reference/checks/url-delete

Check warning on line 392 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L392 

Use 'URL' instead of 'url'.
- /api-reference/checks/multistep-create
- /api-reference/checks/multistep-get
- /api-reference/checks/multistep-update
Expand All @@ -396,30 +399,30 @@
- /api-reference/checks/heartbeat-update
- /api-reference/checks/heartbeat-delete

#### API - Check Groups

Check warning on line 402 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L402 

'API - Check Groups' should use sentence-style capitalization.
- /api-reference/check-groups/list
- /api-reference/check-groups/create
- /api-reference/check-groups/get
- /api-reference/check-groups/update
- /api-reference/check-groups/delete

#### API - Check Results

Check warning on line 409 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L409 

'API - Check Results' should use sentence-style capitalization.
- /api-reference/check-results/list
- /api-reference/check-results/get

#### API - Check Status

Check warning on line 413 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L413 

'API - Check Status' should use sentence-style capitalization.
- /api-reference/check-status/list
- /api-reference/check-status/get

#### API - Check Alerts

Check warning on line 417 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L417 

'API - Check Alerts' should use sentence-style capitalization.
- /api-reference/check-alerts/list
- /api-reference/check-alerts/get

#### API - Heartbeats

Check warning on line 421 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L421 

'API - Heartbeats' should use sentence-style capitalization.
- /api-reference/heartbeats/list
- /api-reference/heartbeats/create

#### API - Private Locations

Check warning on line 425 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L425 

'API - Private Locations' should use sentence-style capitalization.
- /api-reference/private-locations/list
- /api-reference/private-locations/create
- /api-reference/private-locations/get
Expand All @@ -430,34 +433,34 @@
- /api-reference/private-locations/keys-delete
- /api-reference/private-locations/metrics

#### API - Badges

Check warning on line 436 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L436 

'API - Badges' should use sentence-style capitalization.
- /api-reference/badges/check-badge
- /api-reference/badges/group-badge

#### API - Triggers

Check warning on line 440 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L440 

'API - Triggers' should use sentence-style capitalization.
- /api-reference/triggers/trigger-check
- /api-reference/triggers/trigger-group

#### API - Heartbeat Events

Check warning on line 444 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L444 

'API - Heartbeat Events' should use sentence-style capitalization.
- /api-reference/heartbeat-events/list
- /api-reference/heartbeat-events/get
- /api-reference/heartbeat-events/availability

#### API - Client Certificates

Check warning on line 449 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L449 

'API - Client Certificates' should use sentence-style capitalization.
- /api-reference/client-certificates/list
- /api-reference/client-certificates/get
- /api-reference/client-certificates/create
- /api-reference/client-certificates/update
- /api-reference/client-certificates/delete

#### API - V2 API

Check warning on line 456 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L456 

'API - V2 API' should use sentence-style capitalization.
- /api-reference/v2/check-groups-list
- /api-reference/v2/check-groups-get
- /api-reference/v2/check-results-get

### API - Communicate

Check warning on line 461 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L461 

'API - Communicate' should use sentence-style capitalization.

#### API - Alert Channels

Check warning on line 463 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L463 

'API - Alert Channels' should use sentence-style capitalization.
- /api-reference/alert-channels/list
- /api-reference/alert-channels/create
- /api-reference/alert-channels/get
Expand All @@ -465,15 +468,15 @@
- /api-reference/alert-channels/delete
- /api-reference/alert-channels/subscriptions

#### API - Alert Notifications

Check warning on line 471 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L471 

'API - Alert Notifications' should use sentence-style capitalization.
- /api-reference/alert-notifications/list

#### API - Dashboards

Check warning on line 474 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L474 

'API - Dashboards' should use sentence-style capitalization.
- /api-reference/dashboards/list
- /api-reference/dashboards/get
- /api-reference/dashboards/create

#### API - Status Pages

Check warning on line 479 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L479 

'API - Status Pages' should use sentence-style capitalization.
- /api-reference/status-pages/list
- /api-reference/status-pages/create
- /api-reference/status-pages/get
Expand All @@ -482,9 +485,9 @@
#### API - Incidents
- /api-reference/incidents/list

### API - Resolve

Check warning on line 488 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L488 

'API - Resolve' should use sentence-style capitalization.

#### API - Maintenance Windows

Check warning on line 490 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L490 

'API - Maintenance Windows' should use sentence-style capitalization.
- /api-reference/maintenance-windows/list
- /api-reference/maintenance-windows/create
- /api-reference/maintenance-windows/get
Expand All @@ -494,7 +497,7 @@
## Guides
- /guides/overview

### Guides - Monitoring Guides

Check warning on line 500 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L500 

'Guides - Monitoring Guides' should use sentence-style capitalization.
- /guides/end-to-end-monitoring
- /guides/startup-guide-detect-communicate-resolve
- /guides/getting-started-with-monitoring-as-code
Expand All @@ -503,32 +506,32 @@
- /guides/uptime-monitoring
- /guides/keyword-monitoring
- /guides/sdlc-monitoring
- /guides/create-multiple-monitors

Check warning on line 509 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L509 

'multiple' is too wordy.

### Guides - API Monitoring

Check warning on line 511 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L511 

'Guides - API Monitoring' should use sentence-style capitalization.
- /guides/monitoring-an-openapi-spec
- /guides/monitoring-the-stripe-api
- /guides/setup-scripts-for-apis

### Guides - E-commerce Monitoring

Check warning on line 516 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L516 

'Guides - E-commerce Monitoring' should use sentence-style capitalization.
- /guides/monitoring-ecommerce-apps-using-playwright
- /guides/monitoring-ecommerce-apps-using-terraform

### Guides - Playwright Guides

Check warning on line 520 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L520 

'Guides - Playwright Guides' should use sentence-style capitalization.
- /guides/moving-from-puppeteer-to-playwright
- /guides/developer-fixtures
- /guides/auto-waiting-methods
- /guides/reading-traces

### Guides - Advanced Topics

Check warning on line 526 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L526 

'Guides - Advanced Topics' should use sentence-style capitalization.
- /guides/claude-code-monitoring
- /guides/how-to-monitor-broken-links

Check warning on line 528 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L528 

'monitor' is too wordy.

## Learn

### Learn - Playwright

Check warning on line 532 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L532 

'Learn - Playwright' should use sentence-style capitalization.
- /learn/playwright/overview
- /learn/playwright/what-is-playwright

Check warning on line 534 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L534 

Try to avoid using 'is'.
- /learn/playwright/how-to-set-up-locally
- /learn/playwright/testing-pyramid
- /learn/playwright/assertions
Expand Down Expand Up @@ -570,7 +573,7 @@
- /learn/playwright/user-signup-automation
- /learn/playwright/debugging-errors
- /learn/playwright/debugging
- /learn/playwright/error-click-not-executed

Check warning on line 576 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L576 

Be careful with 'executed', it's profane in some cases.
- /learn/playwright/error-element-not-found
- /learn/playwright/error-element-not-visible
- /learn/playwright/error-target-closed
Expand All @@ -582,7 +585,7 @@
- /learn/incidents/incident-management-challenges
- /learn/incidents/reduce-mttd
- /learn/incidents/slo-sla-sli
- /learn/incidents/what-is-incident-response

Check warning on line 588 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L588 

Try to avoid using 'is'.
- /learn/incidents/automation-incident-response
- /learn/incidents/incident-assessment-severity
- /learn/incidents/on-call-schedule
Expand All @@ -607,7 +610,7 @@
- /learn/kubernetes/operators-metrics
- /learn/kubernetes/structured-logging

### Learn - Monitoring

Check warning on line 613 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L613 

'Learn - Monitoring' should use sentence-style capitalization.
- /learn/monitoring/overview
- /learn/monitoring/intro-to-sdlc
- /learn/monitoring/metrics-every-team-needs
Expand All @@ -617,16 +620,16 @@
- /learn/monitoring/real-user-monitoring
- /learn/monitoring/synthetic-monitoring
- /learn/monitoring/transaction-monitoring
- /learn/monitoring/web-application-monitoring

Check warning on line 623 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L623 

Use 'app' instead of 'application'.
- /learn/monitoring/https-for-app-developers
- /learn/monitoring/tcp-and-ssl
- /learn/monitoring/what-is-tcp

Check warning on line 626 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L626 

Try to avoid using 'is'.

### Learn - OpenTelemetry

Check warning on line 628 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L628 

'Learn - OpenTelemetry' should use sentence-style capitalization.
- /learn/opentelemetry/overview
- /learn/opentelemetry/getting-started-with-observability
- /learn/opentelemetry/how-to-instrument
- /learn/opentelemetry/what-is-the-otel-collector

Check warning on line 632 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L632 

Try to avoid using 'is'.
- /learn/opentelemetry/logs
- /learn/opentelemetry/metrics
- /learn/opentelemetry/traces
Expand All @@ -637,16 +640,16 @@

## Comparisons

### Comparisons - Frameworks

Check warning on line 643 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L643 

'Comparisons - Frameworks' should use sentence-style capitalization.
- /comparisons/frameworks/playwright-vs-cypress
- /comparisons/frameworks/playwright-vs-selenium
- /comparisons/frameworks/playwright-vs-others

---

## Common URL Patterns for Link Fixing:

Check warning on line 650 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L650 

'Common URL Patterns for Link Fixing:' should use sentence-style capitalization.

### BROKEN → CORRECT MAPPINGS:

Check warning on line 652 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L652 

'BROKEN → CORRECT MAPPINGS:' should use sentence-style capitalization.
- `/alerting/` → `/communicate/alerts/`
- `/alerting-and-retries/` → `/communicate/alerts/`
- `/alerting-and-retries/retries/` → `/communicate/alerts/retries`
Expand All @@ -668,4 +671,4 @@

- `/status-pages/` → `/communicate/status-pages/`

- `/monitoring/global-locations/` → `/concepts/locations` (likely)

Check warning on line 674 in sitemap-crawl.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

sitemap-crawl.md#L674 

Use parentheses judiciously.
Expand Down
15 changes: 10 additions & 5 deletions snippets/agent-example.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
<Card title="Create new checks, alert channels or other constructs" horizontal>
"Can you create a new `BrowserCheck` monitoring `example.com`"
</Card>

<Card title="Gather information about the current monitoring setup" horizontal>
"What are the currently used monitoring locations?"
"Can you set up a new `BrowserCheck` for `example.com`?"
</Card>

<Card title="Bulk-update your monitoring resources" horizontal>
"Can you change all checks to run every 5 minutes instead of every 10 minutes?"
</Card>

<Card title="Gather information about alerts and your monitoring setup" horizontal>
"I just received an alert. Can you tell me details about the failing checks?"
</Card>

<Card title="Handle and communicate incidents" horizontal>
"Can you please open an incident and investigate a fix?"
</Card>