Contribution guide

Local setup

NPM must be installed (ref. Download Node.js):

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
nvm install 20
node -v
npm -v

Python must be installed.

Task (taskfile.dev) is used to simplify the commands and unify with the CI/CD pipelines:

sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin

NPM packages are required:

task setup

Lint the code with:

task lint

Presentations are build with:

Presentation powered by MkDocs.

Start a local web server:

task docs:serve

Open the documentation on 127.0.0.1:8000.

MkDocs configuration is read from mkdocs.yml.