Guide

Guide

Contribution Guide

How students can add new tutorials, release notes, and reproducibility instructions.

Add a new doc

  1. Add a new entry in _data/docs.yml with a unique id.
  2. Write a concise summary for the left menu preview.
  3. Break detailed instructions into short sections and ordered steps.

Keep docs reusable

  1. Prefer commands and concrete expected outputs over long background paragraphs.
  2. Mention hardware, dataset, and software versions when they affect reproducibility.
  3. Update the doc whenever the corresponding repository changes.