A serious documentation for Nim

> Nim was not designed for beginners. I thought we were here to make it convenient for everybody ! What a disillusion for me ! > don't use what you don't understand" goes a long way. You can write programs > successfully without templates or macros So to make things simple, many features in th

A serious documentation for Nim

> But comes close. It's not one place to learn, but links to many places, many non comprehensive resources. > it points me to which > contains: That runnableExample and few paragraphs are basically all w

A serious documentation for Nim

> I thought we were here to make it convenient for everybody ! What a > disillusion for me ! Same for me, I thought you at least know how to use your browser.

A serious documentation for Nim

> There is not ONE place online, where you can learn ALL what is possible with > Nim. But comes close. There is also , I do search for "server" and it points me to

A serious documentation for Nim

> I do feel that beginners (as in, less experienced programmers, people who > haven't used many languages, not all new nim users) might find this style of > documentation intimidating, because there's not much hand holding. Well that's why the two kinds of doc have to cohabit. As I said in a pre

A serious documentation for Nim

> considering how much Nim offers, the existing documentation, especially the > official one, is absolutely ridiculously minuscule > > If Nim would have at least a hundred times (...) the amount of higher quality > documentation, I guarantee, that the user base of this language would > skyrocke

A serious documentation for Nim

> The manual is also available as a PDF. When I say that we can't learn a lang with a single page, I'm not talking about the way it presented, but about the length of the content. Everything is summarized in the manual, to fit it a single web page.

A serious documentation for Nim

> That's why there's the three-part tutorial Well that is a very good example of what a language official tutorial should look like. Now we have to: * Assemble it in a single resource, readable online and downloadable * Add many many many things in it to make it comprehensive * Tra

A serious documentation for Nim

Same issue with Nim in action: it's an external resource, nobody can guarantee that Dr Salewski will always be available to update his book. In fact few things in it are already outdated. And no, it is not really comprehensive.

A serious documentation for Nim

There is a pretty comprehensive tutorial for nim that is aimed st beginners, that is sadly missing from the official link list.

A serious documentation for Nim

> Nim in Action has been pretty comprehensive for my needs as a web developer A programming language can't rely on a book, that is not part of it official docs, to teach people how it works. There is no guarantee that the book will evolve to match each new version of the language. And even if it

A serious documentation for Nim

> I do feel that beginners (as in, less experienced programmers, people who > haven't used many languages, not all new nim users) might find this style of > documentation intimidating, because there's not much hand holding. Nim was not designed for beginners. I happen to think it's not the worst

A serious documentation for Nim

> The BIGGEST reason I cannot always shout out about Nim to everyone I know > with good conscience is exactly because of this documentation issue. Try to shout anyway, a subset of "everyone" can appreciate the documentation in spite of your personal feelings about it. Not everybody has your prog

A serious documentation for Nim

Personally, I feel the Nim documentation is decent, compared to say what you might find on cppreference.com. The sections are terse, but they generally give enough info for those who know what they are looking for. Having everything in 1 page saves me the effort from having to navigate a website

A serious documentation for Nim

> But for the moment, I think that the situation is bad enough to justify a > complete rewrite of the manual. That moment will pass. ;-) > It's really not possible to learn a programming language from a to z by > reading a single page. The manual is also available as a PDF. And if it weren't y

A serious documentation for Nim

> It's really not possible to learn a programming language from a to z by > reading a single page. That's why there's the three-part tutorial. And Mr. Salewski's book.

A serious documentation for Nim

Thank you. Been thinking that since I saw Nim for the first time. The biggest issue with Nim is that the amount of documentation is laughable. Yes. I know all the books & **I have read all the official documentation entirely, several times**. Including all the documentation regarding standard li

A serious documentation for Nim

Nim in Action has been pretty comprehensive for my needs as a web developer, it teaches you how to use Sinatra-like framework with an ORM to create a functional product. Awesome Nim is also a good place to start in seeing a compilation of all Nim resources, definitely a good place to start. I w

A serious documentation for Nim

Anyone do anything challenge P.S. the manual is more of a specification than a learning resource. It's just more complete than existing learning resources

A serious documentation for Nim

hey man i just have a quick question, what if we add the dir() function like python have list and descriptions about the module and lib ... please check dir func of python reply me

A serious documentation for Nim

> User archnim2 shows up a couple of months later and complains our docs are bad I know that no idea there will always be things to complain about. But for the moment, I think that the situation is bad enough to justify a complete rewrite of the manual. It's really not possible to learn a progra

A serious documentation for Nim

Another thing that might happen is that large number of people who will be happy about new documentation. Also, archnim2 might provide their own improvements as well, increasing the overall quality of the docs.

A serious documentation for Nim

If such a committee has to be created, here are the main goals that they have to seek according to me : 1- Unify the docs: All the links in can be a real source of confusion. They should be assembled in two documentations: a better version of the manua

A serious documentation for Nim

Now don't get me wrong, the docs can be improved, as always and the reported bug is even funny, but when you're successful in your rewrite of the docs, here is what might happen: * You publish your work, proud of having accomplished something. * We link to it from our website. * User archn

A serious documentation for Nim

Well I have nothing to add.

A serious documentation for Nim

> Are there any documentation posts that you've seen that can be adapted in > this manner? Create an issue for this, compile a list of improvements? There is not just a list of specific issues in the docs. The fact is that they have to be completely rethought in a way that allows people learn de

A serious documentation for Nim

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 + Doing a quick search on google turns up a pa

A serious documentation for Nim

Sorry but the links on are not sufficient at all. And nobody have to pay, to learn other languages. Just put yourself at the place of somebody that is new to Nim and tries to understand how to create a http server in Nim. You will see very quick what I'm

A serious documentation for Nim

> Few days ago, I opened a thread, on this forum just to ask about a detail in > std/logging, because there was no explanation about it in the docs. This one Can > There is the logrotate tool on many *nix systems and i think the > RollingFIleLogger is

A serious documentation for Nim

I hope to see a better documentation too. I would like to see a gentle introduction for asynchronous and its internal implementation details. It would be appreciated if can be tackled too.

A serious documentation for Nim

> If you said "module X has no examples for action Y" this would've been an > actionable statement that can be turned into an issue for anyone to fix. Well what I mean is that somebody learns Nim, they may struggle a lot to gather all the information necessary to be a really efficient developer

A serious documentation for Nim

There are also multiple books you can buy to learn the language, it sounds like you're not aware. In addition to that, there is: covering: "Nim by Example" "Learn Nim in 5 minutes" "Tutorial part 1" "Tutorial part 2" "Macro tutorial" "Nim for Begin

A serious documentation for Nim

Nim-lang conducts a yearly community survey with results available on the blog. [2021](https://nim-lang.org/blog/2022/01/14/community-survey-results-2021.html), [2020](https://nim-lang.org/blog/2021/01/20/community-survey-results-2020.html), [2019](https://nim-lang.org/blog/2020/02/18/communit

A serious documentation for Nim

See threads from 2019 and 2022

A serious documentation for Nim

> we should create a documentation committee with a dedicated forum of > discussion space Maybe instead start with figuring out what is wrong _exactly_? You say "documentation is hard". This is a general, non-actionable statement. If you said "module X has no examples for action Y" this would'v

A serious documentation for Nim

A serious issue that we should seriously address in 2023 if we really want Nim to grow, is the documentation. Nim is one of the easiest system languages to use, but one of the hardest to learn. The only way to learn the language is to read the manual which describes the entire language in a sing