generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
Merged
Changes from all 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 52c053d
docs: add skills install action to CLI reference
stefanjudis f62548d
Update snippets/agent-example.mdx
stefanjudis 399ec7a
Update snippets/agent-example.mdx
stefanjudis b4e1466
Update snippets/agent-example.mdx
stefanjudis 292c831
Update ai/markdown-access.mdx
stefanjudis f23b7ac
Update ai/markdown-access.mdx
stefanjudis 2bdfb2b
docs: update sitemap-crawl with AI as its own section
stefanjudis 930dce1
docs: add alternative skills CLI install command
stefanjudis 94ae9f9
docs: fix skills CLI add command shorthand
stefanjudis 3cbcd9a
Apply suggestion from @guolau
stefanjudis 9068db7
docs: streamline markdown access page
stefanjudis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/detect/synthetic-monitoring/browser-checks/overview.md | ||
| ``` | ||
|
|
||
| ## Additional resources | ||
|
|
||
| - [Markdown Access](/ai/markdown-access) | ||
| - [Checkly Skills](/ai/skills) | ||
| - [Checkly Rules](/ai/rules) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| <Tip> | ||
| Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation. | ||
| </Tip> | ||
|
|
||
| ## .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/). | ||
stefanjudis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </Tip> | ||
|
|
||
| ## Copy as Markdown button | ||
|
|
||
| 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. | ||
|
|
||
| This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context. | ||
|
|
||
| ```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? | ||
| ``` | ||
|
|
||
|
|
||
| ## Additional resources | ||
|
|
||
| - [Checkly Skills](/ai/skills) | ||
| - [Checkly Rules](/ai/rules) | ||
stefanjudis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.