![resume / curriculum vitae](/img/cv.png)
![twitter](/img/x.png)
One best practice we follow regarding documentation is to keep it close to what it describes, we prefer including those files together with the actual code, in a different docs/
folder. We write them in Markdown because it is a simple and easy to understand format that is automatically rendered correctly when browsing those files in Gitlab.
And because we are Gitlab users, we are also able to use other features like Gitlab pages and the mermaid
support in markdown to generate even better and useful documentation.
There is Gitlab repository that demonstrates this process, important bits about this specific repository are:
.gitlab-ci.yml
configuration explicitly using the forked image and copying the CSS fixes before the build, andreadthedocs
theme and docker support.The final result: