Skip to main content

​
Keeping Quality in LearnPack Tutorials

Quality gate: use learnpack audit to scan configuration, links, images, and exercise structure before you publish. 🧪

​
Audit your tutorial

With LearnPack you can audit your repository and check for possible errors. Run: 
learnpack audit

​
LearnPack audit errors

The audit command currently validates:
  1. Basic learn.json: the configuration must include slug, repository, and description.
  2. No user or session files in the repo: when LearnPack runs it generates session files (telemetry, login, etc.). Remove them before publishing. You can fix this by running learnpack clean.
  3. Empty or missing files: every step must include at least one README file.
  4. Broken links: scans step instructions to ensure no links return 404.
  5. Valid image URLs (relative or absolute): scans step instructions to ensure all images load correctly.
  6. Exercise directory names: folders must follow LearnPack’s convention, starting with a number and a descriptive name.
  7. exercises array contains session content: a contig.json file is generated during a session and should be emptied before publishing.

​
LearnPack audit warnings

  1. Inconsistent translations.
  2. Missing .gitignore.
  3. Loose files: files inside the exercises folder but not within any specific exercise directory.
Tip: after fixes, run learnpack audit again until your repository is clean. For student-side data hygiene, remind learners to avoid committing files generated under .learn/.

​
Next up

​
See also