Given how many folks had issues with jesters that I directed towards Prologue 
and that went "Finally, docs!" I'd say jester as well :-P

Generally I try to slowly but surely get people to adopt what I deem as "gold 
standard" in my view:

  * doc comments on your public API and a github workflow that deploys the 
API-index so that you have reference documentation
  * For larger projects (think owlkettle or norm) where a readme becomes 
cumbersome, use nimibook for introductory/teaching documentation with compiled 
examples (like 
[owlkettle](https://can-lehmann.github.io/owlkettle/docs/tutorial.html) and 
[norm](https://norm.nim.town/models.html) have them). That enforces correctness 
in your documentation since the docs won't build if the examples can't compile, 
while not polluting your source-code with elaborate explanations about 
architecture of a package or mechanisms of a feature.



That's why I've started sharing my [obisidian 
notes](https://github.com/PhilippMDoerner/NimSetup) on the topic with gentle 
guidance of folks towards that direction.

Reply via email to