Modules
Module Library Overview
The source overview and contributor contract for Learning Lab modules.
This is the source overview and contributor contract for Learning Lab modules. The generated /modules/ page is the complete inventory; this overview does not duplicate that catalog by hand.
Each module gets its own folder because a module may later render into multiple formats: classroom, short, longform, essay, article, app, handout, facilitator guide, or another learning artifact.
Minimum module structure:
module.md: durable source file for the module.
The optional canonical-module-v1 page contract adds a sibling README.md containing an H1 that matches the module title, a Return to module link, one nonempty ## Summary, and one ## Change log. Before production, the change log contains exactly No production releases yet. At the first authorized production release, replace that sentence with ### YYYY-MM-DD — Go Live; later meaningful production changes appear above it in reverse chronological order. Internal development noise is omitted.
The contract is applied one module at a time. Existing module READMEs retain their current purpose until explicitly migrated.
Common module subfolders can be added as the module grows:
sections/assessments/indexes/publishable-artifacts/generation/assets/
Hands-on activity packages live in the top-level Lab Library. A module should link to its related labs there rather than creating a new activities/ package.
Source: modules/README.md