Files
coursebank/CHANGELOG.md
T
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

3.8 KiB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to calendar versioning (YY.MM.PATCH); see README.md.

[Unreleased]

Added

  • First public release.
  • Student reports add bonus questions and curves to the score and show how the total adds up, so it matches Gradescope and Canvas. Class means, bands, and grade distributions use the same total.
  • A zero-point Gradescope question with no option columns is recorded as a curve.
  • ingest warns when a question dropped as removed still gives every student points on the platform.
  • Schema 2.1, which is additive: a course that validated under 2.0 validates with no new errors. Rerun coursebank schema to pick up the new and changed JSON Schemas, including the new glossary.schema.json.
    • Four registries beside objectives and targets: terms (term-), equations (eq-), values (val-), and misconceptions (mis-), each defined once in an objective file, a new glossary.yaml, or course.yaml. Ids are unique across every registry.
    • Targets list the entries they turn on (terms, equations, values, misconceptions), carry a student-facing explanation, and keep the item-writing judgments in authoring.
    • Objectives and lectures gain a description, lectures gain materials, readings gain minutes, and bank options gain misconception_id.
    • policy gains levels (the course's names for levels 1 to 5), exam_conditions, blueprints, and target_text_forbid. No command reads exam_conditions or blueprints yet.
    • Brace references such as {term-gap-penalty} in student-facing prose render as links, values, quoted beliefs, or target numbers.
    • authoring, notes_private, evidence, conflicts, and status never reach a student page, report, or export.
  • validate checks the registries: id prefixes, ids unique across registries, the entries each target lists, equation symbols, values, citation keys, brace references, that every regular expression compiles, and each option's misconception_id.
  • Fourteen lint rules in a glossary family, from glossary-unused to glossary-proposed, and a note severity for the two that report conventions rather than problems.
  • lecture page ID writes a whole lecture page: description, objectives and targets with explanations and named ceilings, new and earlier terms, equations, numbers to know, common mistakes, readings with minutes, and materials. lecture glossary writes the course glossary page.
  • Student reports show what meeting each missed target looks like, the correction for a registry misconception, and group misses that share one.
  • migrate glossary --terms terms.yaml --values values.yaml brings 1.0 side files into glossary.yaml, reports what it renamed and dropped, and is a no-op when run again.

Changed

  • lint --min-severity defaults to note, and lint fails only on findings above a note.
  • The crate depends on regex, built without its optional features.

Fixed

  • A record with points: 0 on a bonus question no longer erases the points the platform awarded.
  • A curve whose position matches a recorded question number is no longer discarded at ingest.
  • Gradescope files named with the question's title, such as 39_Curve.csv, are now read. They used to be skipped without a word, which left titled questions and curves out of the totals. Any other CSV file in the directory now draws a warning, and two files for one question are refused. Re-ingest to pick this up.
  • The assessment JSON Schema now accepts dropped_as, dropped_before_printing, stem_digest, and learning_objectives on a placement, all of which the loader already read. Rerun coursebank schema to pick this up.