The website of the 2026 OSSS course. Currently in development, includes the working plan.
The website is a Quarto book. GitHub Actions rebuilds it from main when changes are merged, and publishes the rendered site to the gh-pages branch for GitHub Pages to serve.
To preview the website locally, run from the book folder:
python -m pip install -r requirements.txt
quarto render --to html
(requires Quarto to be installed).
This generates the website in book/_site for local review. After a PR is merged into main, CI rebuilds the site and publishes it to gh-pages automatically.
The easiest way to contribute chapters will be to make a new branch and open a PR to add a new chapter (I have been pushing to main, but will stop now).
To add a new chapter it should be sufficient to create the qmd file in the root and add the file to
the index.qmd.
Some things I have included, we can discuss if they are useful and worth including them across all chapters:
- During the course we will walk them through the key code sections. Then after each natural section, we can have a 'things to try' box. We'll give them some time to play around and try these things out on their own.
- 'Concept Notes' is a page that contains expanded definitions / explanations of concepts. For example in the introduction chapter, we mention data streams, or the fact data is stored in int16 unitless. It's a bit much to go into it in the middle of the chapter, but can link to a longer explanation. We link internally including a little 💡 by the link.
Currently this is the default quarto book style, maybe we can jazz it up as we go along.