docs: align custom agent eval docs with skill field#283
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for writing eval.yaml specs so that custom agents are targeted via the existing skill: field (matching the current Go eval spec model and JSON schema), and removes/avoids the misleading agent: field in examples.
Changes:
- Update
eval.yamlreference docs to describeskill:as the single required target field (for both skills and.agent.mdcustom agents). - Update the custom agents guide examples and key points to use
skill:when evaluating.agent.mdagents.
Show a summary per file
| File | Description |
|---|---|
| site/src/content/docs/guides/eval-yaml.mdx | Removes agent: from the top-level fields and switches custom-agent targeting examples to skill:. |
| site/src/content/docs/guides/custom-agents.mdx | Updates eval.yaml examples/instructions to target agents using skill: instead of agent:. |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
…223556219+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #275
Summary
skill:for custom agents, matching the existing eval parser and schema.agent:eval field from the docs.Validation
go test ./...cd site && npm cicd site && npm run buildDocumentation impact
site/src/content/docs/guides/custom-agents.mdxsite/src/content/docs/guides/eval-yaml.mdx