Yes, that is a good example because it is a lot more actionable. I did a search 
and apparently there are no open issues related to documentation content 
<https://github.com/nim-lang/Nim/issues?q=is%3Aissue+threads+label%3A%22Documentation+Content%22>+

Doing a quick search on google turns up a paywalled piece of the "nim in 
action" book <https://livebook.manning.com/book/nim-in-action/chapter-6/16> but 
I don't think anyone starting to learn a language would be thrilled about 
spending $20 on the book (it is discounted now, usually it is $40) or $62 
[https://www.amazon.com/Mastering-Nim-complete-programming-language/dp/B0B4R7B9YX/ref=sr_1_1?crid=27JR555Q4SQ8K&keywords=mastering+nim&qid=1666896008&qu=eyJxc2MiOiIwLjIzIiwicXNhIjoiMC4wMCIsInFzcCI6IjAuMDAifQ%3D%3D&sprefix=mastering+nim%2Caps%2C229&sr=8-1](https://www.amazon.com/Mastering-Nim-complete-programming-language/dp/B0B4R7B9YX/ref=sr_1_1?crid=27JR555Q4SQ8K&keywords=mastering+nim&qid=1666896008&qu=eyJxc2MiOiIwLjIzIiwicXNhIjoiMC4wMCIsInFzcCI6IjAuMDAifQ%3D%3D&sprefix=mastering+nim%2Caps%2C229&sr=8-1)
 "only physical" no matter the amount of advertisement by the authors.

So your specific complaint about the "threads" documentation, and similar 
instances, are the main starting points for the documentation improvements. I 
haven't done any thread-based programming in nim (nor async for that matter), 
so I can't provide any suggestions for what might be added into the 
documentation (since I don't have any requests that would be based on my 
experience), but you can just list things that you would want to see there, or 
things that you had to search elsewhere.

So to summarize, what I'm sayin is:

  1. Your specific instance of confusion can become the starting point for 
documentation improvement, the more specific the better
  2. People who can write docs often suffer from the so called "curse of 
knowledge" and are a lot better at answering the questions rather than speaking 
about things in general. Formulate your confusion in form of general questions, 
just like you would ask on the forum/thread.


Reply via email to