Skip to content

Commit 9068db7

Browse files
committed
docs: streamline markdown access page
Rephrase skills tip, simplify copy-as-markdown description, and remove verbose AI assistant usage examples.
1 parent 3cbcd9a commit 9068db7

1 file changed

Lines changed: 5 additions & 28 deletions

File tree

ai/markdown-access.mdx

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ sidebarTitle: 'Markdown Access'
66

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

9+
<Tip>
10+
Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation.
11+
</Tip>
12+
913
## .md endpoints
1014

1115
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
4145

4246
## Copy as Markdown button
4347

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

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

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-
5652
```text
5753
Here is the Checkly Browser Checks documentation:
5854
@@ -61,25 +57,6 @@ Here is the Checkly Browser Checks documentation:
6157
Based on this, how do I set up a browser check with a custom user agent?
6258
```
6359

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

8461
## Additional resources
8562

0 commit comments

Comments
 (0)