docs: cross-reference audit for recent renames and feature additions#230
Merged
Conversation
- Add .agent.md coverage to quick-start.mdx, getting-started.mdx, docs/GETTING-STARTED.md, docs/GUIDE.md, docs/TUTORIAL.md for #226 - Add custom-agent, required-skills-demo, rubrics to examples/README.md - Update mock engine description in docs/INTEGRATION-TESTING.md and eval-yaml.mdx to reflect #228 file content echo behavior - No stale BenchmarkSpec/TestRunner refs found (#222 rename was thorough) Co-authored-by: Copilot <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.
Summary
Comprehensive documentation audit triggered by three recent merges: #222 (BenchmarkSpec/TestRunner rename), #226 (custom agent support), and #228 (mock engine file echo).
What changed
.agent.md coverage gaps (#226)
Added custom agent mentions to 6 onboarding entry points that were missed:
site/src/content/docs/quick-start.mdx— added Aside tip + link to custom-agents guidesite/src/content/docs/getting-started.mdx— added tip calloutdocs/GETTING-STARTED.md— added blockquote notedocs/GUIDE.md— added bullet to feature list + agent argument towaza rundocs/TUTORIAL.md— added note linking to custom agents guideMissing examples (#226)
examples/README.md— added entries forcustom-agent,required-skills-demo, andrubricsdirectoriesMock engine description (#228)
docs/INTEGRATION-TESTING.md— updated mock description from 'Simulates responses' to accurately describe task metadata + file content echo behaviorsite/src/content/docs/guides/eval-yaml.mdx— updated executor table descriptionWhat was deliberately NOT changed
BenchmarkSpec/TestRunnerreferences found in any auditable docs — the rename PR was thoroughdocs/design/194-baseline-skill-impact.md— contains historicalBenchmarkSpec/TestRunnerreferences; this is a point-in-time design doc, left as-isdocs/images/*— not touched per audit scope (separate screenshot workflow)Verification