Skip to content

docs(education): add eval-driven-development examples page#716

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-eval-driven-development
Jul 4, 2026
Merged

docs(education): add eval-driven-development examples page#716
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-eval-driven-development

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Creates docs/education/eval-driven-development.md: how to think about correctness when "correct" is a distribution, with four worked examples drawn from real Magpie skills (issue-triage classification, prompt-injection resistance, prose grading with a judge model, and structural assertions for multi-field output). Wired to the framework's shared eval harness (tools/skill-evals/) rather than a parallel approach.

Also creates docs/education/README.md — the landing-page index for the maintainer-education stream — with eval-driven-development.md as the first stable link and the remaining stream pages (pattern-catalogue, your-first-skill, workshops) listed as Planned until their own branches land.

Generated-by: Claude (Opus 4.7)

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

Worked examples on judging agent correctness when output is a distribution,
and flip its row in the education index to a live link.

Generated-by: Claude Code (Opus 4.8)
@potiuk
potiuk force-pushed the education-eval-driven-development branch from ee69be6 to 4b5fb37 Compare July 4, 2026 17:01

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Re-reviewed after rebase onto main (post-#715). Minimal diff: adds docs/education/eval-driven-development.md and flips its row in the canonical education README to a live link + Ready — no competing README. Outbound links resolve; placeholder-clean; TOC matches headings; no emojis. lychee clean. LGTM.

@potiuk
potiuk merged commit b69dd72 into apache:main Jul 4, 2026
34 checks passed
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