Skip to content

docs(education): add AI tutor discoverability to education and training READMEs - #927

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:ai-tutors-doc-discoverability2
Jul 30, 2026
Merged

docs(education): add AI tutor discoverability to education and training READMEs#927
potiuk merged 1 commit into
apache:mainfrom
justinmclean:ai-tutors-doc-discoverability2

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Add a "Learn with an AI tutor" section to docs/education/README.md and docs/education/training/README.md, pointing learners to ai-tutors/README.md with brief how-to-load instructions (paste below the --- separator as the system prompt). Confirms ai-tutors/README.md already lists all eleven lessons.

Generated-by: Claude (claude-sonnet-4-6)

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:

…ng READMEs

Add a "Learn with an AI tutor" section to docs/education/README.md and
docs/education/training/README.md, pointing learners to ai-tutors/README.md
with brief how-to-load instructions (paste below the --- separator as the
system prompt). Confirms ai-tutors/README.md already lists all eleven lessons.

Generated-by: Claude (claude-sonnet-4-6)
@justinmclean justinmclean self-assigned this Jul 27, 2026

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

LGTM — useful discoverability fix, and the coverage claim holds up. Two observations below, neither gating.

I checked the claim rather than assuming it, since "each lesson has a matching tutor" is the kind of thing that quietly stops being true:

  • docs/education/README.md's progression lists 11 numbered pages; ai-tutors/ has 11 lesson-*.md files, and they line up 1:1 by name (what-agents-arelesson-01-what-agents-are, through contributinglesson-11-how-to-contribute). The training module map is also 11.
  • The two supporting references (pattern catalogue, tutorials) have no tutors, but they are explicitly not lessons in the progression, so the wording is accurate.
  • The three tools named — claude.ai Projects, Open WebUI, API — match what ai-tutors/README.md actually documents.
  • Both relative paths resolve, and the doctoc entries were added alongside the headings.

Smaller observations

  • the --- separator is ambiguous, and following it literally breaks the tutor. Every one of the eleven lesson files contains exactly two --- lines: the first splits reader-notes from the tutor prompt, and the second sits inside the prompt, dividing the tutor instructions from ## KNOWLEDGE BASE. A reader told to "find the --- separator" who lands on the second pastes only the knowledge base and loses the entire tutor persona — a failure that looks like the prompt simply not working.

    One word fixes it:

    **How to load a tutor:** open the matching `lesson-*.md` file under `ai-tutors/`,
    find the **first** `---` separator, and paste everything below that line as the
    system prompt.
    

    Worth knowing this is inherited, not introduced here: ai-tutors/README.md says "Each file has two parts split by a --- line", which has the same imprecision. So this PR propagates it into two more places rather than creating it. Fixing all three would be ideal; fixing the two new copies is the cheap half.

  • Three copies of the loading procedure now exist. The how-to-load paragraph is duplicated into both READMEs verbatim, alongside the original in ai-tutors/README.md. Given the separator wording above is already drifting from what the files contain, that is the concrete argument for a one-line pointer plus the link instead of a copy — the link cannot go stale, the paraphrase can. Not worth blocking a discoverability improvement over, but if the procedure changes again there are now three places to remember.


This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The maintainer
approving this PR has read the findings and signed off. If
something feels off, please reply on the PR and a maintainer
will follow up.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md § Opening a pull request.

@potiuk
potiuk merged commit f1d9bfe into apache:main Jul 30, 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