feat: enhance AI IDE documentation with indexing instructions and custom rules (#1299)

- Added a section on indexing Checkly documentation in various IDEs for improved code generation.
- Introduced custom rules for AI IDEs to guide code generation specific to Checkly.
- Included detailed setup instructions for GitHub Copilot, Cursor, and Windsurf on Windows and Mac/Linux.
- Created a new file for Checkly rules to standardize code generation practices.

Co-authored-by: Tim Nolet <[email protected]>

Author: aluedeke

site/content/docs/ai/use-checkly-with-ai-ide.md

@@ -3,15 +3,75 @@ title: Using Checkly with AI IDEs and Copilots - Checkly Docs
 displayTitle: Use Checkly with AI IDEs & Copilots
 navTitle: Use Checkly with AI IDEs & Copilots
 weight: 3
-draft: true
 beta: true
 menu:
   platform:
     parent: "AI"
 ---
 
-## GitHub Copilot
+## Docs
 
-## Cursor
+You can index our docs pages in your IDE to leverage better code generation results. Todo so follow the guides for your IDE of choice:
 
+Make sure to index the following url:
 
+```txt
+https://checklyhq.com/docs/
+```
+
+- [Cursor](https://docs.cursor.com/context/@-symbols/@-docs)
+
+At the time of writing this unfortunately no other IDE supports this kind of context enrichment.
+
+## Custom Rules
+
+We prepared a first set of ai rules which you can use to teach your AI IDE of choice on how to generate code for Checkly.
+
+Go into the root of your IDEs workspace and download the rules according to your IDEs config parameters.
+
+When asking questions about Checkly manually add the download rules files to your prompt.
+
+### GitHub Copilot
+
+Windows
+
+```powershell
+New-Item -ItemType Directory -Path ".github\instructions" -Force
+Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/docs/ai/checkly.rules.md" -OutFile ".github\instructions\checkly-api-check.md"
+```
+
+Mac and Linux
+
+```bash
+mkdir -p .github/instructions && curl -o .github/instructions/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
+```
+
+### Cursor
+
+Windows
+
+```powershell
+New-Item -ItemType Directory -Path ".cursor\rules" -Force
+Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly.rules.md" -OutFile ".cursor\rules\checkly-api-check.mdc"
+```
+
+Mac and Linux
+
+```bash
+mkdir -p .cursor/rules && curl -o .cursor/rules/checkly-api-check.md  "https://www.checklyhq.com/docs/ai/checkly.rules.md"
+```
+
+## Windsurf
+
+Windows
+
+```powershell
+New-Item -ItemType Directory -Path ".windsurf\rules" -Force
+Invoke-WebRequest -Uri "https://www.checklyhq.com/docs/ai/checkly-api-check.md" -OutFile ".windsurf\rules\checkly-api-check.md"
+```
+
+Mac and Linux
+
+```bash
+mkdir -p .windsurf/rules && curl -o .windsurf/rules/checkly-api-check.md "https://www.checklyhq.com/docs/ai/checkly.rules.md"
+```

site/static/docs/ai/checkly.rules.md

@@ -0,0 +1,44 @@
+# Checkly
+
+- refer to docs for checkly cli v5
+- to generate the initial setup for checkly use the command `npm create checkly@latest`
+- check the checkly cli output to figure out into which folder the setup was generated
+- use the [checkly cli reference](https://www.checklyhq.com/docs/cli/command-line-reference)
+- use the [checkly test api](https://www.checklyhq.com/docs/cli/constructs-reference)
+- always ground generated code and cli commands against the official documentation
+- when referencing environment variables always use the handlebar syntax `{{MY_ENV_VAR}}`
+- when referencing secrets always use the handlebar syntax `{{MY_SECRET}}`
+- after the initial setup is done ask the user for which endpoints to generate api checks
+- check in the code if api endpoints require authentication
+- if endpoints require authentication ask the user which authentication method to use and then generate a setupScript to authenticate the given requests
+- referenced setupScript for ApiChecks must be plain ts files and not export anything
+
+## Project Structure
+
+checkly.config.ts - Mandatory global project and CLI configuration. We recommend using TypeScript.
+src/__checks__/* - TS/JS files defining your checks and other resources.
+package.json - Standard NPM project manifest.
+Here is an example directory tree of what that would look like:
+
+.
+|-- checkly.config.ts
+|-- package.json
+`-- src
+    `-- __checks__
+      |-- alert-channels.ts
+      |-- api-check.check.ts
+      `-- homepage.spec.ts
+
+The checkly.config.ts at the root of your project defines a range of defaults for all your checks.
+## `ApiCheck`
+
+- Checkout the api docs for [API Checks](https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck) before generating any code.
+- Only use assertions for Api Checks which are [documented](https://www.checklyhq.com/docs/cli/constructs-reference/#assertionbuilder)
+- test api checks using `npx checkly test` command pass env variables using `-e` parama, use `--record` to persist results and `--verbose` to be able to see all errors
+
+### Authentication Setup Scripts
+
+- setupScripts should be flat scripts, no functions, no exports, they will be executed straight by Checkly
+- use axios for making http requests
+- read the input credentials from env variables using process.env
+- pass auth tokens to the request object using `request.headers['key'] = AUTH_TOKEN_VALUE`