Skip to content

Contributing

Run the docs locally

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Open http://127.0.0.1:8000.

Conventions

  • Documentation is in English, so the material is useful beyond the room. The workshop itself is delivered in Norwegian, and participant-facing copy on the landing page is Norwegian.
  • The submitted abstract in Proposal stays in Norwegian, verbatim. It's the record of what was filed — translate alongside it, never over it.
  • One page per topic; add it to nav: in mkdocs.yml.
  • Every command a participant types must be copy-pasteable and actually tested.
  • Prefer admonitions (!!! tip, !!! danger) over bold-shouting.

Build strictly before pushing

mkdocs build --strict

Publishing

Pushes to main build and deploy to GitHub Pages via .github/workflows/docs.yml.