Files
coursebank/docs/design/2.1
alexmandClaude b5cae6afac 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>
2026-11-16 12:31:01 -05:00
..

coursebank 2.1 and the lecture-spec pipeline

file what it is who reads it
CLAUDE-CODE-PROMPT.md the prompt for a new Claude Code session in the coursebank repository; copy this folder to docs/design/2.1/ and paste the prompt you, then Claude Code
SCHEMA-CHANGES.md the specification: what changes, why, the rules, the rendering, the migration Claude Code (authoritative), you (to review)
schemas/ the target 2.1 JSON Schemas (glossary.schema.json is new) Claude Code
schemas-original/ your 2.0 schemas, so diff -r schemas-original schemas shows every change
build_schemas.py the script that produced schemas/ from schemas-original/, every edit in one place
examples/v20/ 2.0 fragments that must still validate tests
examples/v21/ a small 2.1 course using every new field; lecture-page-preview.md is the page it should render tests, and you, to see the format in use
examples/migration/ a 1.0 terms.yaml and values.yaml and the glossary.yaml the migration should write tests
prototype/check21.py an executable sketch of every new rule; --selftest breaks the example once per rule, --page l09 prints the lecture page Claude Code (to port), you (to try the rules)
PIPELINE-DESIGN.md the design of the lecture-spec pipeline, built once coursebank validates 2.1 you

Checked here: every schema is valid JSON Schema (2020-12); the 2.0 examples validate under both 2.0 and 2.1; the 2.1 examples and the migration's expected output validate under 2.1, merged and as fragments; the 2.1 fragments are rejected by 2.0; bad ids, bad enum values, unknown keys and missing required fields are rejected; all 19 prototype rules fire on their broken case; the example course has no errors.