MicroSim Standardization

Overview

This skill validates and standardizes MicroSim directories to ensure they meet quality and documentation standards. MicroSims are interactive educational simulations that may use various JavaScript libraries (p5.js, vis-network, Chart.js, etc.). This skill performs a comprehensive audit of a MicroSim directory, generates a TODO list of required upgrades, and optionally implements the standardization changes. After this process runs, a quality_score will be added to the index.md metadata. A rubric of how the quality score is provided and this score should be shown to the user before and after the changes.

Note on Terminology

There are two types of metadata for a MicroSim.

1. yml header metadata: - this metadata is inserted into the top of the index.md file. This is to support the social image previews. The mkdocs social_preview extension uses these fields. The quality_score is also stored here.
2. :Dublin core metadata - These metadata elements are ONLY stored in the metadata.json file.

Do not mix these up! Never put Dublin Core metadata into the yml headers.

Workflow

Step 1: Receive MicroSim Directory Path