docs: surface eval --scaffold (repo-tailored eval generation) earlier - #19
Merged
Conversation
The repo-specific eval scaffolding was buried at the bottom of the evals guide and absent from the README quickstart + docs landing, so users rarely discovered that AgentRig can auto-generate eval scenarios from their own stack. Surface it first: - README: add `eval --scaffold` to the quickstart, open the eval section with a callout, and note the flag in the commands table. - docs landing: mention scaffold in the "Evals you can run" feature card. - getting-started: add `eval --scaffold` as the first step of "3. Evaluate". - evals guide: add a top-of-page pointer to the Per-repo customization section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Merged
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
1 participant
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.
Problem: the per-repo eval customization —
agentrig eval --scaffold, which auto-generates eval scenarios from your repo's stack — was buried at the bottom ofdocs/evals.mdand missing from the README quickstart, the docs landing page, and getting-started. New users rarely discovered that the eval kit can tailor itself to their repo.Change: surface it in the high-traffic, first-impression spots.
eval --scaffoldto the quickstart block; opened the "Evaluating the harness itself" section with a callout; added the flag to the commands table.index.md) — the "Evals you can run" feature card now calls out scaffolding scenarios from your stack.eval --scaffoldis now the first step of "3. Evaluate", framed as the fastest way to make the eval kit yours.No behavior/code changes — docs only. Adds a
patchchangeset (the README ships to npm).Verification:
npm run docs:buildsucceeds (markbook build complete); working tree shows only the 4 intended docs files + the changeset.