(doc): Spring documentation challenge
Description
With the latest Sight 21.0, we would like to have better documentation.
Proposal
We would like to introduce a README.md file for each library/module/activity/config/app/target/tutorial/example. This is a more modern approach to document the features in the code. This was done for instance for sight::geometry::data
or sight::geometry::glm
. While doing that, we can remove the files Namespace.hpp
.
To achieve this, we organize a documentation challenge. Every day, the bot will ping developers on the #kanban channel and assign a random target to be processed. Not more than 30 minutes should be dedicated to that. Since some targets are big, it might not be feasible to achieve the work in this amount of time. If it is not finished, commit what was done so far and the target will have to be processed later on.
Outcomes
That will just be awesome!