**A1 More links to resources at Nim documentation page?**

Instead of a bag of stuff, consider following logical reading order:

Official essential documentation

  * Frequently Asked Questions
  * Tutorial
  * Language Reference
  * Standard Library
  * Compiler User Guide



Other official documentation

  * Searchable index
  * Nim Backend Integration
  * Nimble Package Manager
  * Garbage Collector
  * Internal Documentation
  * Source code filters
  * Bleeding Edge Docs



Further reading

everything else on the current page nicely categorised, and more, such as:

  * [https://en.wikipedia.org/wiki/Nim](https://en.wikipedia.org/wiki/Nim)
  * 
[https://rosettacode.org/wiki/Category:Nim](https://rosettacode.org/wiki/Category:Nim)
  * 
[https://github.com/VPashkov/awesome-nim](https://github.com/VPashkov/awesome-nim)
  * [https://github.com/dom96/choosenim](https://github.com/dom96/choosenim) 
(alas, the usage part is missing)
  * [https://nim-lang.org/docs/nep1.html](https://nim-lang.org/docs/nep1.html)
  * roadmap



but: the link to Wiki should be removed until it's contents are polished

**A2 What resources are needed?**

How-to tutorial about building and deploying a production-ready web server for 
a SPA would be a killer. Something like: postgresql <-> json <-> httpbeast <-> 
web sockets (systemd, let's encrypt, nginx and the like can naturally be 
assumed to exist)

**A3 Do you find Rosetta Code useful?**

  * In theory it's useful for comparing the look and feel of Nim with other 
languages
  * In practice it's useful because the examples are runnable, not some 
snippets without context



**A4 Do you think code practice sites are useful for learning the language?**

Not really

**B5 Show us the examples of good documentation**

Well, Ceylon language had a top-notch web site and documentation: 
[https://ceylon-lang.org](https://ceylon-lang.org)/

I especially liked that the language specification was readable yet sound: 
[https://ceylon-lang.org/documentation/1.3/spec/html_single](https://ceylon-lang.org/documentation/1.3/spec/html_single)/

**B6 What does the GD consist of?**

  * Purpose and scope
  * Logical grouping and reading order
  * Relevant and up-to-date hypertext cross-references
  * Relevant and up-to-date hypertext links to outside resources and further 
reading/discussion
  * Runnable examples and/or output of examples given



**B7 Pain points of Nim documentation?**

Standard library module/file/package docs lack (links to) runnable examples.

**B8 Is there any Nim module that doesn 't need any improvements?**

There's always room for improvement (but not time to do it)

**B9 Show us Nim modules which have very good documentation?**

[https://nim-lang.org/docs/re.html](https://nim-lang.org/docs/re.html)

**B10 Are you willing to help making Nim documentation better? :)**

My time is scarce, but maybe I could start combing through all Nim forum posts 
and make a list of things that should be mentioned in the documentation. 
(Googling and finding relevant forum posts has saved my a..day many times, but 
outdated answers are a pain in the a..day).

Reply via email to