docs(education): add Training module index and lesson 1 (what-agents-are)#779
Conversation
…agents-are) Scaffolds docs/education/apache-training/ with a module index (README.md) and lesson-01-what-agents-are.md — the first LMS-neutral lesson wrapper for the maintainer-education stream. Each lesson adds per-lesson learning objectives, hands-on exercises, and self-check questions on top of the existing source pages, shaped for upstream contribution to Apache Training. The module map in the README lists all 11 lessons as placeholders; lesson 1 is the first concrete delivery. Sub-item 1 of the education-apache-training-module epic (plan item 5). The remaining lesson wrappers, the instructor/facilitator guide, and the upstream-contribution hand-off are separate sub-items. Generated-by: Claude (claude-sonnet-4-6)
|
I run through the full AI prompt tutor manually - but would be interested in other people's views on this. I currently have drafts for the 10 others, but need to go through them manually one by one. |
potiuk
left a comment
There was a problem hiding this comment.
Approving — docs-only, and it checks out: every internal link resolves, SPDX headers are present on all new files, markdown is well-formed, and the AI-agent content is accurate and consistent with the existing docs/education/ pages. The couple of cosmetic nits (SPDX-vs-doctoc ordering in ai-tutors/README.md; the "Files" table listing tutor prompts that ship in later lessons) are non-blocking.
This is the base of the training-lesson stack (#779 → #780 → #781 → #782); once this lands, please rebase the others onto main so each reduces to its own lesson delta. Thanks @justinmclean.
This review was drafted by an AI-assisted tool and confirmed by a Magpie maintainer. The maintainer approving this PR has read the findings and signed off.
More on how Magpie handles maintainer review: CONTRIBUTING.md.
Summary
Scaffolds the first concrete Training lesson wrapper and AI tutor companion for the maintainer-education stream.
This adds the Lesson 1 classroom wrapper at docs/education/training/lesson-01-what-agents-are.md, covering per-lesson learning objectives, no-computer exercises, self-check questions, and answer keys on top of the existing “What agents are” source page. It also adds ai-tutors/lesson-01-what-agents-are.md plus a refresh script for injecting the source lesson knowledge base into tutor prompts.
The training module README now tracks the full 11-lesson map, with Lesson 1 as the first concrete delivery and later lessons/lab listed as placeholders. The source page and lesson wording were tightened around tool permissions, context limits, and probabilistic variation so the classroom wrapper and tutor prompt teach the same concepts consistently.
Generated-by: Claude (claude-sonnet-4-6)
Type of change
.claude/skills/<name>/) — eval fixtures updated belowtools/<system>/*.md)tools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)projects/_template/)prek, workflows, validators)Test plan
prek run --all-filespassesuv run pytest/ruff check/mypypasses(
PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)(a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)