3 ms·
Documentation could be so much better
- wruza 5y agoMy worst experience with md docs is lack of indents and margins and ambigous header styles. E.g. this: https://www.npmjs.com/package/express-session https://www.npmjs.com/package/express-session I just can’t parse it, seems like it is not structured in any way at all. The second issue is a very bad technical structure, which sometimes tells more than a paragraph of text in much less time. Compare the above to this: https://docs.gtk.org/gtk4/class.Button.html https://docs.gtk.org/gtk4/class.Button.html It has all of the features: visual distinction, summaries, separate pages full of technical details and edge cases, clear structure that repeats among other classes. I really hate it that most docs went that stupid md route with walls of text in single file and no toc.