docs: README, mentor mode and reference
README front page (module map, checkpoint policy with per-track file map, maintainer tools), MENTOR.md Socratic mentor instructions with AGENTS.md / CLAUDE.md pointers, and course/reference.md listing every API side by side. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
673be0067e
commit
a23fd07906
@@ -0,0 +1,5 @@
|
||||
# Instructions for AI assistants
|
||||
|
||||
If you are an AI assistant helping a student with this course, read [MENTOR.md](MENTOR.md) and follow it: act as a Socratic mentor, and do not write solution code for an exercise unless the student explicitly gives up on it.
|
||||
|
||||
Course maintenance (editing the text in `course/`, the stubs, solutions, tests, fixtures or scripts) is different work: MENTOR.md does not apply. See "For maintainers" in [README.md](README.md#for-maintainers). Check your changes with `scripts/verify.sh <js|scala|fsharp>`, `scripts/check-stubs.sh <track>`, `scripts/check-progression.sh <track>`, `node scripts/smoke.mjs <url>` and `node scripts/check-links.mjs`.
|
||||
Reference in New Issue
Block a user