Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
justinmclean wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/education/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [What every page also teaches](#what-every-page-also-teaches)
- [How this connects to the other guides](#how-this-connects-to-the-other-guides)
- [About the examples](#about-the-examples)
- [Learn with an AI tutor](#learn-with-an-ai-tutor)
- [Licence](#licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -140,6 +141,23 @@ Every example uses placeholders in place of real names: `<PROJECT>`,
skill, you change your own settings, not the example text. If you ever see a
real project name written into a skill, that is a bug.

## Learn with an AI tutor

Each lesson in the progression above has a matching AI tutor prompt in
[`ai-tutors/`](../../ai-tutors/README.md). Load one into any capable chat
model and it teaches that lesson interactively — walking through the ideas one
at a time, running the exercises, and checking your answers against the lesson
keys.

**How to load a tutor:** open the matching `lesson-*.md` file under `ai-tutors/`,
find the `---` separator, and paste everything below that line as the system
prompt. The notes above the separator are for you; only the text below goes to
the model. See [`ai-tutors/README.md`](../../ai-tutors/README.md) for
tool-by-tool instructions (claude.ai Projects, Open WebUI, API).

The tutors are companions to the readable pages, not replacements for them.
Every lesson in this progression stands on its own without a model.

## Licence

Everything in `docs/education/` is under the Apache License 2.0 (PRINCIPLE 17).
Expand Down
17 changes: 17 additions & 0 deletions docs/education/training/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [Delivery formats](#delivery-formats)
- [Prerequisites](#prerequisites)
- [Placeholders](#placeholders)
- [Learn with an AI tutor](#learn-with-an-ai-tutor)
- [Licence](#licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -99,6 +100,22 @@ control. Specific technical prerequisites are stated in each lesson.
Exercises use `<PROJECT>` wherever a real project name would appear.
Substitute your own project name when working through the activities.

## Learn with an AI tutor

Each lesson in the module map above has a matching AI tutor prompt in
[`ai-tutors/`](../../../ai-tutors/README.md). Load one into any capable chat
model and it teaches that lesson interactively — working through the
objectives, exercises, and self-check questions one step at a time.

**How to load a tutor:** open the matching `lesson-*.md` file under `ai-tutors/`,
find the `---` separator, and paste everything below that line as the system
prompt. The notes above the separator are for you; only the content below goes
to the model. See [`ai-tutors/README.md`](../../../ai-tutors/README.md) for
tool-by-tool instructions (claude.ai Projects, Open WebUI, API).

These prompts are companions to the lesson wrappers, not a replacement for the
source pages or in-person instruction.

## Licence

Apache License 2.0 (PRINCIPLE 17). Contributions carry a `Generated-by:` note
Expand Down