Skip to content

docs(education): education training lesson 04#782

Merged
potiuk merged 15 commits into
apache:mainfrom
justinmclean:education-training-lesson-04
Jul 8, 2026
Merged

docs(education): education training lesson 04#782
potiuk merged 15 commits into
apache:mainfrom
justinmclean:education-training-lesson-04

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Adds lesson 4 of the Apache Training maintainer-education module: Your first skill.

This PR includes:

  • docs/education/training/lesson-04-your-first-skill.md, an LMS-neutral lesson wrapper for the existing your-first-skill.md source page.
  • ai-tutors/lesson-04-your-first-skill.md, an interactive tutor prompt with the lesson knowledge base, exercises, answer keys, and self-check guidance embedded.
  • A module index update linking lesson 4 from docs/education/training/README.md.
  • The lesson covers skill frontmatter, the propose/confirm/act rule, placeholder use, eval-suite structure, and the Step 0 through Step 6 authoring workflow. The exercises are designed to work without a computer and include answer keys for classroom or tutor use.

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:

Add `docs/education/apache-training/lesson-02-working-with-agents.md`
wrapping the "How to work with agents" source page with learning
objectives, four exercises (four-ingredient request, mid-task steering,
data-not-instructions, context-and-correction), and a five-question
self-check with hidden answers.

Also bring in the module README and lesson-01 scaffold from the
`education-apache-training-lesson-01` in-flight branch — both are
needed because the `apache-training/` directory does not yet exist on
main. When lesson-01 merges first this branch rebases cleanly:
lesson-01.md and the README will already be on main, and only the
lesson-02 file plus the README's lesson-2 link update land as a diff.
Update the README module map to link lesson-02 as a real file, and
fix lesson-01's "Next" pointer to point at the lesson-02 file rather
than the raw source page.

Generated-by: Claude Code (Sonnet 4.6)
Standardize the Apache Training curriculum module path on
docs/education/training/ (matching the education-*-lesson-01 branch) and
fix the two path references in upstream-contribution.md.
…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)
Add lesson-03-choosing-models.md, the Apache Training wrapper for the
How to use different models source page. Covers the three-way tradeoff
(capability/speed/cost), task-complexity classification, the judge-model
pattern, local vs hosted tradeoffs, and eval-driven model selection.
Includes four paper-based exercises and five self-check Q&As.

Also carries forward the full apache-training directory (README, lesson-01,
lesson-02) since the directory does not exist on main yet. Updates the
README module map to link lesson 3, and updates lesson-02 Next section
to point to the new lesson file.

Generated-by: Claude (claude-sonnet-4-6)
Standardize the Apache Training curriculum module path on
docs/education/training/ (matching the education-*-lesson-01 branch) and
fix the two path references in upstream-contribution.md.
Add lesson-04-your-first-skill.md to docs/education/apache-training/,
with learning objectives, four paper exercises (propose/confirm
classification, placeholder violations, frontmatter authoring, eval
suite design), and five Q&A self-check blocks. Update README module
map to link lesson 4; copy prior lesson files (01–03) from their
in-flight branches so this branch is self-contained from main.

Generated-by: Claude Code (Sonnet 4.6)
Standardize the Apache Training curriculum module path on
docs/education/training/ (matching the education-*-lesson-01 branch) and
fix the two path references in upstream-contribution.md.
# Conflicts:
#	ai-tutors/lesson-01-what-agents-are.md
#	ai-tutors/lesson-02-working-with-agents.md
#	docs/education/training/README.md
#	docs/education/training/lesson-01-what-agents-are.md
#	docs/education/training/lesson-02-working-with-agents.md

@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.

Approving — Training lesson 4 (your-first-skill). Content verified against the canonical docs/education/your-first-skill.md and root AGENTS.md: frontmatter fields, the eval "three files", the three case types, and the Step 0–6 workflow all match; links resolve; SPDX present. I brought the branch up to main after #779#781 landed, so the net diff is just the lesson-4 delta. Nice series. 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.

@potiuk potiuk merged commit 1b05580 into apache:main Jul 8, 2026
9 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