Skip to content

Adding documentation

Contributions to improve or extend on the documentation and tutorials provided on this website are appreciated. In order to keep the documentation format and style coherent, please follow these steps.

  1. Fork the gevolution-2.0 repository, where the documentation is kept. See versions
  2. Open ./docs repository in your favourite editor.
  3. Edit the relevant markdown files, or create new ones. Link to them appropriately in mkdocs.yml.
  4. For seeing the changes locally, you can use mkdocs serve in the docs folder. This requires pip install mkdocs, see tutorial.
  5. Once you are happy with the changes, submit a pull request from your fork, see tutorial.

Then one of the administrators will review and accept your changes. If making large contributions, you will be recognised as a contributor on the about page. If a long-term contributor, you will be added as an administrator.