-
Notifications
You must be signed in to change notification settings - Fork 20
feat: add README documentation for monitoring agent skill #1212
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
Conversation
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
There was a problem hiding this 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-context→prepare-ai-contextfor 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:
- Adding a separate message for the README copy operation
- 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.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
|
thebiglabasky
left a comment
There was a problem hiding this 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...') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| console.log('📝 Compiling context template with examples...') | |
| console.log('📝 Preparing context template with examples...') |
| └── SKILL.md # Main skill instructions | ||
| ``` | ||
|
|
||
| ## What is an Agent Skill? |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Affected Components
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:
compile-ai-context.ts→prepare-ai-context.tsfor clearer namingskills/monitoring/README.md- the public-facing documentation for skill consumerspackages/cli/src/ai-context/README.md- source file that gets copied to dist during buildThe 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.