Skip to content

Contributing to Caseum

Thank you for investing your time in contributing to our project!

Any contributions you make are governed by our License.

Please follow our Code of Conduct to keep our community approachable and respectable.

You could read the open source contribution guide for general advice on how to contribute.

Since this is a small hobby project, your contribution may not be noticed for a while if we are busy elsewhere. Sorry!

The introduction presentation is built with Quarto.

Run quarto render docs/public/presentations/introduction.qmd to render.

(The presentation is modified so rarely the outputs are checked into git.)

This site is built with Astro Starlight.

Tools are pinned in .mise.toml; run mise install once. Then:

  • mise run docs-install - Install the site dependencies (bun).
  • mise run docs-dev - Start the live-reloading docs server.
  • mise run docs-build - Build the documentation site into docs/dist.