Add separate documentation
So far, I see the following options:
- GitHub pages
- Publish to Readthedocs
- GitHub/GitLab Wiki
I prefer using GitHub pages as in this case all documentation lives inside the docs
folder of the main repository and we would not have to set up any docs building task in the CI. We might want to use Jekyll Just the Docs theme.
Using the wiki has the disadvantage the docs would live in a second repo, which would be difficult to sync between GitLab and GitHub. Readthedocs is not fully under our control and puts ads in the docs.