You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ai/markdown-access.mdx
+5-28Lines changed: 5 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ sidebarTitle: 'Markdown Access'
6
6
7
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
8
9
+
<Tip>
10
+
Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation.
11
+
</Tip>
12
+
9
13
## .md endpoints
10
14
11
15
Append `.md` to any documentation URL to get the markdown version of that page.
@@ -41,18 +45,10 @@ Modern coding agents set [these headers automatically when querying documentatio
41
45
42
46
## Copy as Markdown button
43
47
44
-
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.
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.
45
49
46
50
This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context.
47
51
48
-
## Feeding documentation to AI assistants
49
-
50
-
Here are some patterns for using Checkly documentation with AI tools:
51
-
52
-
### Single page context
53
-
54
-
When you need help with a specific feature, copy that page's markdown and include it in your prompt:
55
-
56
52
```text
57
53
Here is the Checkly Browser Checks documentation:
58
54
@@ -61,25 +57,6 @@ Here is the Checkly Browser Checks documentation:
61
57
Based on this, how do I set up a browser check with a custom user agent?
62
58
```
63
59
64
-
### Multiple page context
65
-
66
-
For complex tasks, combine multiple relevant pages:
67
-
68
-
```text
69
-
I need to set up monitoring for my API. Here is the relevant documentation:
70
-
71
-
## API Checks
72
-
[paste api-checks.md]
73
-
74
-
## Alerting
75
-
[paste alerting.md]
76
-
77
-
Help me set this up step by step.
78
-
```
79
-
80
-
### Built-in agent documentation
81
-
82
-
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.
0 commit comments