A. > 1\. Do you think there should be more links to the existing (user-created) > resources? If so, which ones?
Yes, but I don't know. > 2\. What resources are needed? Video tutorials, how-to tutorials for some > field X (what is X for you?), cookbook (there is/was one, but it seems it is > not updated anymore), etc. Complete how-to tutorials: web development, machine learning with _Arraymancer_ , mobile dev. Those are niche topics currently, the easier and more complete the tutorial should make entry barrier lower for people to use/try Nim > 3\. Have you used Rosetta Code for learning how to do things in Nim? Do you > find it useful? Yes, but quite rarely. Usually when I have no specific thing to do. > 4\. Have you used code practice sites like Exercism to learn Nim (or some > other language)? Do you think they are useful for learning the language? (Or > in Nim case: would they be useful if they had more Nim exercises availbable?) Never used it. Yes, I think it's useful for learning Nim. B > 5\. Can you show us the examples of 'good documentation' (GD, later in the > text) in other programming languages? Python documentation, Rust (but it's introduction book, not the their documentation, strangely, I found Nim documentation is easier to read than Rust's, it's just need some example and elaborate explanation on how to use the module/libs) > 6\. What does the GD consist of? For each module, a general explanation of > what it does, code examples of its usage? Long explanations of each > function/type/constant? Lots of examples for each function? Links to other > modules? Something else? Yes pretty much like this. > 7\. What is you major pain point when using Nim documentation? Is it hard to > find the module(s) which would be useful to you? Can you understand what a > function does based on the description and the example? Are (most of the > time) the examples missing or not informative enough? Nothing major but need time to browse the list and getting familiar with any libs available (for the first time), afterward I usually just head to "the_index". Sometimes I understand, mostly not. I understand if I have been working with that libs quite often, but when first time using it, need time to digest the information. (but it's normally like that right?) _Asyncdispatch_ and _strscans_ has elaborate explanation, as for _asyncdispatch_ unfortunately that's still not enough for me on how to use it effectively :/ > 8\. Is there any Nim module which satisfies your criteria for GD? (It is good > as it is, doesn't need any improvements) If we think the GD is like Python's doc, then none. But pretty much the current doc is mostly self-explainable for me. > 9\. Can you show us Nim modules which, in your opinion, have very good > documentation? (Only small improvements are needed to make it GD) [strscans](https://nim-lang.org/docs/strscans.html) > 10\. Are you willing to help making Nim documentation better? :) More than willing, just need the documentation, ehem I mean guide :D , to contribute to documentation
