From e93f1a1a4662e7438eaf09fec42145776d2b2844 Mon Sep 17 00:00:00 2001 From: Asterios Raptis Date: Fri, 24 Jul 2026 09:48:08 +0200 Subject: [PATCH] docs: replace the faked-dash pauses in the repo prose (engine#80 follow-up) Same rule as the engine docs sweep (engine#80 / engine PR #85): a spaced hyphen standing in for an em-dash pause is rewritten by context (colon, comma, parentheses). Repo prose only; learner content is out of the rule's scope and untouched. Co-Authored-By: Claude Fable 5 --- README.md | 2 +- docs/GETTING-STARTED.md | 4 ++-- docs/export-set-usage.de.md | 2 +- docs/export-set-usage.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0a2faa2..0d42b36 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,7 @@ Full usage guide and best practices (incl. the source-chapter workflow): ## Export a graded quiz to PDF (school tests) `scripts/export_quiz_pdf.py` turns a lesson that carries a graded-quiz -exercise (an `ext:*-graded-quiz`: a scored question set - points per +exercise (an `ext:*-graded-quiz`: a scored question set, points per question, optional partial credit on multi-select, an optional percentage pass threshold) into two print-ready PDFs: diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md index 2635a75..547441e 100644 --- a/docs/GETTING-STARTED.md +++ b/docs/GETTING-STARTED.md @@ -108,7 +108,7 @@ All N set(s) passed validation. If it fails, the message names the lesson and the rule (e.g. `free_text '…' needs distractors`). Fix and re-run. -**Before you push**, also run the engine gate locally - the same semantic +**Before you push**, also run the engine gate locally: the same semantic rules (stable rule ids such as `E-CARD-REF`, cloze markers, multiple-choice rules) that CI enforces in the `Engine conformance` workflow: @@ -119,7 +119,7 @@ make lint The first run installs the engine release pinned in `schema/engine-version.txt` into `node_modules/` (gitignored; needs Node.js and npm); later runs reuse it. It then runs the gate's self-test plus the -full engine pass over every lesson and manifest - so `E-*` errors show up +full engine pass over every lesson and manifest, so `E-*` errors show up before the push, not after. Optionally, `make lint-warnings` prints the engine gate's warnings (`W-*`) for every lesson; warnings do not fail the run. diff --git a/docs/export-set-usage.de.md b/docs/export-set-usage.de.md index 024cda3..0b79c5d 100644 --- a/docs/export-set-usage.de.md +++ b/docs/export-set-usage.de.md @@ -1,4 +1,4 @@ -# Set-Export für KI-Review - Nutzung und Best Practices +# Set-Export für KI-Review: Nutzung und Best Practices > English version: [export-set-usage.md](export-set-usage.md) diff --git a/docs/export-set-usage.md b/docs/export-set-usage.md index 1adbf7e..6f51e46 100644 --- a/docs/export-set-usage.md +++ b/docs/export-set-usage.md @@ -1,4 +1,4 @@ -# Export a set for AI review - usage and best practices +# Export a set for AI review: usage and best practices > Deutsche Version: [export-set-usage.de.md](export-set-usage.de.md)