Skip to content

docs: describe the engine-owned rules and the engine-gated generator - #46

Merged
astrapi69 merged 1 commit into
mainfrom
docs/engine-owned-rules-followup
Oct 1, 2026
Merged

astrapi69 merged 1 commit into
mainfrom
docs/engine-owned-rules-followup

Conversation

@astrapi69

Copy link
Copy Markdown
Owner

Summary

adaptive-learner-content-template#92 moved the content rules to the engine. Its wave carried only the template-owned files, so this repository's own README.md and docs/GETTING-STARTED.md still describe the old tooling. This PR updates the stale passages and nothing else.

  • Quality rules. free_text and picture_choice no longer need distractors; that requirement was dropped by decision in learn-content-engine#185. The rules are now enforced by the engine gate, not the validator. "purpose": "bridge" and "purpose": "quiz" are explained.
  • Validation failure example. The example message is a structure-gate failure, since that is what validate_content.py still reports.
  • Dependencies. Where named, the validator's dependencies point to requirements.txt (it also needs regex), and Node.js/npm is listed for the engine gate and the generator.
  • Generator. It checks every draft against the mirrored schema and then the pinned engine, and it stops when the engine is not installed. The README no longer describes an engine gate that runs "when installed, otherwise in CI" after generation.
  • Engine gate before push. It also enforces the quality minimums.

Not every passage exists in every repository; each change applies only where the stale text was found.

Test plan

  • Before the change, the stale phrases were found with git grep on origin/main of the template and the nine content repositories. After the change, a scan for the same phrases reports nothing.
  • scripts/check_prose.py reports no new finding in the two changed files.

🤖 Generated with Claude Code

The template's #92 moved the content rules to the engine; its wave
carried the template-owned files only, so this repository's README and
GETTING-STARTED still named the dropped distractor requirement, the
validator as the rule checker, PyYAML as its only dependency and an
optional engine gate after generation.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@astrapi69
astrapi69 merged commit 20dd5ea into main Oct 1, 2026
6 checks passed
@astrapi69
astrapi69 deleted the docs/engine-owned-rules-followup branch October 1, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants