Skip to content

Contributing to the documentation

Contributing

Setting up the development environment

The documentation is stored in Codeberg.

To start working on the documentation, clone the project and then install all required packages:

python -m venv .venv
. .venv/bin/activate

pip install -r requirements.txt

Then you can edit the documentation under docs with your prefered markdown editor.

To view a live updating version, run: mkdocs serve --livereload while the virtual environment (by default under .venv) is active.

Submitting

Before submitting, create a branch, either using the Codeberg Website or your preferred git-client.

If you are not part of the Chaosdorf-Codeberg organization, you need to create a fork and create your branch there.

To submit, create a commit using git and push it, using your preferred client. Then in Codeberg, you should get asked if you want to create a "Pull-Request". Create it and then wait for reviewers to review your changes.

Guidelines

  • When refering to the reader or user directly, prefer to use the generic feminine.