ECE Makerspace Wiki

Running a Workshop

A guide for workshop runners, covering the run checklist, adapting pages, and the frontmatter reference.

Edit this page

So you're running a workshop. This page covers the tooling: how the interactive checklist behaves during a session, and how to adapt a workshop page for your own run.

The run checklist

Each workshop page carries its checklist in its frontmatter. During the session it works like this:

  • Tick items as you go. Progress saves per device, so if you close the page and come back on the same device, your ticks are still there.
  • Print view. If you want paper on the day, use your browser's print function on the workshop page; the checklist renders cleanly for printing.
  • Fresh start per device. Every new device starts unticked. A borrowed laptop or a co-runner's phone starts from zero, by design.

Adapting a workshop page

Workshop pages are wiki pages; exco can edit them at /edit. Open the page source there, adjust the frontmatter and body, and save. The change is live immediately, with no rebuild.

While adapting, keep the overview → session flow → after the session structure members expect, move anything a runner must prepare into the "before" checklist section, and keep checklist labels short: one action per item.

Frontmatter reference

---
title: My Workshop            # page + sidebar title
description: One-line summary  # used in search + sidebar
duration: 60                   # minutes
audience: 'new members'        # who the session is for
checklist:                     # renders as the interactive checklist
  - id: welcome                # kebab-case, unique per item
    label: Welcome & introductions
    section: Before            # groups items into sections
---
  • checklist[].id: kebab-case string, unique within the page.
  • checklist[].label: the visible, tickable text.
  • checklist[].section: the heading items are grouped under (e.g. Before, Session, Wrap-up).

With the frontmatter in place, the checklist component renders automatically at the top of the page; you write the prose around it.

On this page