Resources

Shared, reusable material that supports every course, lab, and exercise across the academy.

Templates

Starter templates for new content live under templates/:

  • templates/course/ — new course website scaffold.
  • templates/lesson/ — standard lesson layout.
  • templates/lab/ — standard lab layout.
  • templates/quiz/ — standard quiz layout.

Authors are expected to copy from these templates and follow the academy conventions rather than inventing new structures per course.

Shared assets

Cross-course assets live under shared/:

  • shared/images/ — reusable diagrams, screenshots, logos.
  • shared/icons/ — icon set used across course sites.
  • shared/css/ — shared stylesheets and theme overrides.
  • shared/javascript/ — shared client-side helpers.
  • shared/includes/ — reusable Quarto includes (callouts, prerequisites, learning-objectives blocks, and other recurring content).

Conventions

Open Engineering already publishes convention repositories that inform how academy content is structured:

Substantial Academy Labs follow the Agentic Learning Loop: Predict → Delegate → Observe → Compare → Generalize → Validate → Internalize. Courses teach; Labs train engineering judgement. Lessons, examples, and small exercises are not required to follow the loop.

Course metadata

Each course carries a metadata.yaml descriptor (see courses/pico/metadata.yaml for the reference example). Machine-readable metadata is what will later drive curriculum maps, dependency graphs, and other automation without changing course content.

Authoring tools

  • Open Engineering Language Server (OELS) — optional learner-facing guide to install and use OELS locally for live diagnostics on OE-shaped .yaml / .yml / .json files, and how to keep OELS feedback distinct from Quarto, bin/pico, and lab verify.sh checks.