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
+8
-5
@@ -20,13 +20,14 @@
|
||||
//! |:--|:--|:--|
|
||||
//! | `course.yaml` | identity, policy, units | you |
|
||||
//! | `references.yaml` | the works the course cites | you |
|
||||
//! | `lectures/*.yaml` | one lecture: readings, and what it teaches | you |
|
||||
//! | `objectives/*.yaml` | one objective and its learning targets | you |
|
||||
//! | `glossary.yaml` | terms, equations, values, and misconceptions no one objective owns | you, or `migrate glossary` |
|
||||
//! | `lectures/*.yaml` | one lecture: readings, materials, and what it teaches | you |
|
||||
//! | `objectives/*.yaml` | one objective, its learning targets, and the glossary entries they first need | you |
|
||||
//! | `banks/*.yaml` | items, with design intent and pooled statistics | you, then `calibrate` |
|
||||
//! | `assessments/*.yaml` | what was given, to whom, when | `assemble`, then you |
|
||||
//! | `data/*.parquet` | one row per student per item | `ingest` |
|
||||
//!
|
||||
//! The first four are one course file split by subject; `coursebank course build`
|
||||
//! The first five are one course file split by subject; `coursebank course build`
|
||||
//! prints the merged result, and a course that keeps everything in `course.yaml`
|
||||
//! still loads unchanged. See [`course::fragment`].
|
||||
//!
|
||||
@@ -75,8 +76,10 @@
|
||||
//!
|
||||
//! ## Dependency posture
|
||||
//!
|
||||
//! Deliberately small: serde, a YAML parser, clap, thiserror, and csv, plus arrow
|
||||
//! and parquet behind a default-on feature that can be switched off. Dates, PRNG,
|
||||
//! Deliberately small: serde, a YAML parser, clap, thiserror, csv, and regex
|
||||
//! (built without its optional features, for the glossary's `conflicts` and
|
||||
//! `target_text_forbid` patterns), plus arrow and parquet behind a default-on
|
||||
//! feature that can be switched off. Dates, PRNG,
|
||||
//! hashing, ZIP writing, and the psychometrics are implemented here rather than
|
||||
//! pulled in — see [`date`], [`rng`], [`hash`], [`zipfile`], [`irt`]. For a tool
|
||||
//! whose job is to still open a course repository in five years, that tradeoff
|
||||
|
||||
Reference in new issue
Block a user