3 ms·
I really love documentation that lives in the same repo with the code. My favorite is a .md file for every module, class or component. Some mixture of inline c
by 20after4 3y ago
I really love documentation that lives in the same repo with the code. My favorite is a .md file for every module, class or component. Some mixture of inline code docs and standalone docs is probably ideal. But docs as markdown that don't require some compile step to build the documentation, and doesn't require opening a browser to view them, is just so much better, IMO, compared to any sort of external docs like a wiki or html on a server somewhere that gets re-generated by a CI job.