docs: schema 2.1 guide, codes, changelog, and report
A guide page for the four registries: where entries live, how targets point at them, the other new fields, the brace-reference table, what students never see, the lecture and glossary pages, every new error and lint rule, and the migration from terms.yaml and values.yaml. The setup guide points at it. The README covers glossary.yaml, the nine schemas, the 2.1 checks, the glossary lint family and the note severity, the new lecture commands and report sections, migrate glossary, and schema version 2.1. Module docs and the changelog follow. docs/design/2.1/CODES.md maps the specification's E, W, and I codes to coursebank's messages and lint codes, each with its test, and REPORT.md records what changed, the two remaining schema differences, every choice made where the specification left room, and suggested changes to it. A new test covers the validation messages the specification does not number. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
11 files changed
+535
-29
No files matched your search
@@ -208,6 +208,12 @@ stimuli:
|
||||
Items reference it with `stimulus: s-dock-poses`.
|
||||
Declaring it here rather than pasting it into four items means a correction to the table happens once.
|
||||
|
||||
### Terms, equations, values, and misconceptions
|
||||
|
||||
Four more registries hold what students study from besides the objectives: the terms they meet (`term-`), the equations they use (`eq-`), the numbers they are taught (`val-`), and the mistakes they commonly make (`mis-`).
|
||||
Each is defined once, in the objective file whose targets first need it or in a `glossary.yaml` beside `course.yaml`, and targets list the entries they turn on.
|
||||
They are optional, and [`glossary`](crate::guide::glossary) covers them, the lecture pages built from them, and the migration from 1.0 `terms.yaml` and `values.yaml`.
|
||||
|
||||
## Check it
|
||||
|
||||
```console
|
||||
@@ -229,6 +235,7 @@ Exit codes are meaningful.
|
||||
|
||||
## Where to go next
|
||||
|
||||
[`glossary`](crate::guide::glossary) adds terms, equations, values, and misconceptions, and builds lecture pages from them.
|
||||
[`authoring`](crate::guide::authoring) writes the first bank.
|
||||
[`first_exam`](crate::guide::first_exam) takes an exam from blueprint to student report.
|
||||
|
||||
|
||||
Reference in new issue
Block a user