I don't want to announce a time frame right now, because I also have a day job 
:)

The idea is pretty simple: We collect all the docs from all the modules which 
are in nimble automatically and add the docs of the compiler and the manual 
itself.

Those get indexed by the Nim compilers own doctools. This generates 
"namespaced" repositorys of documentation per module. We store the data in json 
(jsondoc2) which then is the basis for a SPA style documentation site.

This site will contain documentation for all of Nim and can be cross referenced 
over module borders. It also will offer smart search features over all indexed 
modules. In addition we will construct static indexing sites with all of the 
same information linked in conventional manner which will be indexed by search 
engines.

The site may very well get enhanced eventually with comments but that is not 
planed from the beginning. This would need moderation and could be target for 
spam and stuff. I simply don't want to put that burden upfront.

It may also function as online search for nimble packages as all the 
information would be available there already.

I am in the proof of concept phase and later on we will move to a real database 
backend. I am not sure if that servers code will be public domain. At least it 
will be available for free for Araq. He and me work in the same company and we 
can use our framework for that, which also means that we may host it. My 
Company agreed on investing into Nim some time ago and I guess that may be the 
easiest way to have something really useful for the community.

The basics which are needed for that got included to the compiler in the last 
days. One can now generate all the docs for a project by one command (nim doc2 
--project index.nim, where index.nim is a nim file including everything which 
belongs to the module being documented).

That is the reason why I would love that people start to add documentation in 
the "Nim way", because it will be of use for everyone in the near future.

Reply via email to