code.dlang.org packages' docs

[Seb via Digitalmars-d]

On Tuesday, 24 May 2016 at 15:26:31 UTC, Luís Marques wrote:
> Hi,
>
> code.dlang.org could be improved with regards to the 
> documentation of the packages it lists.
>
> As low hanging fruit, I suggest that the package information 
> table (version, home page, repo, license, etc.) be extended 
> with the documentation URL of the respective package, instead 
> of it being an ad hoc part of the Readme section, and often 
> missing.
>
> More generally, I would suggest that code.dlang.org also served 
> as a centralized repository of the documentation of each 
> package. For instance, the package serial-port 
> (<http://code.dlang.org/packages/serial-port>) links to 
> <http://ncrashed.github.io/serial-port/index.html>. This is 
> another site, with a different visual style and doc generator 
> layout, another possible point of failure, etc. I realize it 
> might be challenging to generate and host all the docs at 
> code.dlang.org, but I feel it would create a more 
> "professional", unified and pleasant experience.

What you are proposing is sth. like "Documentation as a service".
E.g. every time I push a new git tag, please run ddoc/ddox on my 
codebase and store the result. It shouldn't be difficult to 
implement and would be a huge gain for the community. Afaik other 
languages also have this:

http://www.rubydoc.info/
https://github.com/coffeedoc/codo

In terms of resources this shouldn't be a huge deal either. For 
1K and the simple documentation HTMl I would guess it's less than 
1G and as it's static it could be conveniently served via some 
Google/AWS bucket.

Moreover having the documentation for all modules at one place, 
allows the amazing opportunity to be able to search through all 
of them at once like e.g. Hoogle 
(https://www.haskell.org/hoogle/) for Haskell allows.