Skip to content

Conversation

@stefanjudis
Copy link
Collaborator

@stefanjudis stefanjudis commented Feb 6, 2026

Affected Components

  • CLI
  • Docs
  • Create CLI
  • Test
  • Examples
  • Other

Notes for the Reviewer

This is an uncritical change to get our new agent skills closer to public consumption.

This PR prepares the monitoring agent skill for public release by adding documentation.

Changes:

  • Rename compile-ai-context.tsprepare-ai-context.ts for clearer naming
  • Add skills/monitoring/README.md - the public-facing documentation for skill consumers
  • Add packages/cli/src/ai-context/README.md - source file that gets copied to dist during build

The README explains what Agent Skills are, what this skill teaches AI agents to do, and links to relevant Checkly documentation. The dual-file approach (source + public) is intentional for cross-OS compatibility since symlinks don't work reliably everywhere.

Add README.md files documenting the monitoring agent skill for the
Agent Skills release. The skill enables AI agents to create and manage
Checkly monitoring resources.

- Rename compile-ai-context to prepare-ai-context for clarity
- Add README to skills/monitoring/ for public skill consumption
- Add source README to packages/cli/src/ai-context/ for build process
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR prepares the monitoring agent skill for public release by adding comprehensive README documentation and improving the clarity of the build process through better naming.

Changes:

  • Renamed build script and function from compile-ai-contextprepare-ai-context for clearer semantics that reflect the script's dual purpose
  • Added README.md documentation in both source (packages/cli/src/ai-context/) and public (skills/monitoring/) locations
  • Enhanced build script to copy README during the prepare phase for cross-OS compatibility

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
skills/monitoring/README.md New public-facing documentation explaining Agent Skills, the monitoring skill's capabilities, and usage instructions
packages/cli/src/ai-context/README.md Source file for README that gets copied to dist during build process
packages/cli/scripts/prepare-ai-context.ts Renamed from compile-ai-context.ts with added logic to copy README to output directory
packages/cli/package.json Updated npm script names from generate:ai-context to prepare:ai-context for consistency
Comments suppressed due to low confidence (1)

packages/cli/scripts/prepare-ai-context.ts:24

  • The console.log message "Compiled to" is now also used for the README.md copy operation on line 47, but the README is just being copied, not compiled. Consider either:
  1. Adding a separate message for the README copy operation
  2. Making the message more generic like "Written to" or "Output to"

This would make the logs more accurate about what operation is actually being performed.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

⚠️ AI context is out of date

The skills/ directory doesn't match the generated output from packages/cli.

Please run the following locally and commit the changes:

npm run prepare

thebiglabasky
thebiglabasky previously approved these changes Feb 6, 2026
Copy link
Contributor

@thebiglabasky thebiglabasky left a comment

Choose a reason for hiding this comment

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

Minor nits but looks good to me

async function prepareContext () {
try {
// eslint-disable-next-line no-console
console.log('📝 Compiling context template with examples...')
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
console.log('📝 Compiling context template with examples...')
console.log('📝 Preparing context template with examples...')

└── SKILL.md # Main skill instructions
```

## What is an Agent Skill?
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting we need that much to prompt agents to look into the skills. I guess that's the way right now since it's largely an Anthropic thing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This isn't for agents at all. This is actually for humans. :D

For agents, it's pretty much just the SKILL.md and what other things it pulls in. But if someone browses the repo and discovers /skills, there needs to be more concise readmes. 🤷

So it's more or less GH UX and/or marketing. :D

Use clearer, more accurate terminology in console output.
@stefanjudis stefanjudis merged commit 6804373 into main Feb 6, 2026
4 checks passed
@stefanjudis stefanjudis deleted the document-ai-skill branch February 6, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants