Documentation in Packages and Local Interface

[stelford]

Nimble is awesome, but you know what else is awesome ?! documentation. Nimble has good support for it's own command line options, however, imagine you install the 3rd party package FizzBuzz. How do we know what the API is ? what it does ? any limitations ? etc.

Ideally, the nimble file specification would include a 'doc=foo/blah.html'. In this way, it would be easy to see which packages have documentation and which don't. Why is this important ?

I would love a sort of 'nimble docs', which would launch a localhost:4111 (or whatever) with a html TOC for the installed nimble packages. Any which have a markup/html page could be displayed - and I wouldn't have to go on a great goose chase to try and find what the library does etc. It could all be discovered from the top level HTML index.

[dom96]

This might be something that you are looking for: https://nimpkgdir.firelet.net/docs/jester/jester.html

[dom96]

I think a website providing pre-built documentation is the better way to go, for now at least. So this is going to get a low priority :)

[FedericoCeratto]

The "doc" field is partially related to #213 Some of users like having local docs, also the pkg directory cannot display private/unreleased packages. I don't see a need for a local webserver (unless for keyword searches) so opening files in a browser would be enough.