Is there any specific reason to keep the docs in the wiki section? Vs markdown documents right in the wiki itself?
For my self I like to document in the code itself. It has one major benefit which is: I always know where the information is to be found. But there are some problems with it such as
-
creates conflicts when merging changes from another repo or branch
-
it makes the git history a lot messier because you have some commits on functional code and some on comments, all mixed up in a single document. I know with fancier git this could be tidier but I can't reliably work at such a high skill level
-
comments are not subject to syntax formatting so harder to read
-
source document itself becomes too long to read and hard to understand
-
extremely contextual to my skills and challenges at the time when I wrote the code; not what I will need to know in the future and not what others need to know
So not always the way to go.