While going through the README I realised that visdom does not have a really well organized documentation. Till the section of API, Basics and Plotting, things look good but then going ahead we have Generic Plots and Simple Plots. Generic plots have no mention of win or env usage.
I think we need to organize docs properly or use sphinx. If we want to continue with README then I would recommend something well organized and interlinked as in torchnet.
What are your views on this?
shubhamjain0594
All 3 comments
Hi @shubhamjain0594
I suppose I can see what you mean, but I'm not sure I agree that it needs to fundamentally be reorganized. I agree that there are some holes that should be filled though, especially regarding the 'generic plots' details.
ajabri
on 30 Jul 2017
Since there are no proper docs, it becomes difficult to search any particular API without using browser provided search utility. Whenever I or anyone will be using this API, they will have a specific need, and a long README without many intrapage links makes it difficult.
The content is all there but things needs to be re-arranged and indexed with intrapage hyperlinks. For example in APIs section, we can link each API to its definition. This will make things easier to look and use.
shubhamjain0594
on 30 Jul 2017
This is an OSS project, so feel free to submit a PR that makes the documentation easier to navigate.
lvdmaaten
on 29 Sep 2017
Related issues
rdevon
路
5Comments
pedropgusmao
路
3Comments
JiangPQ
路
4Comments
wdroz
路
5Comments
IssamLaradji
路
3Comments
Most helpful comment
Since there are no proper docs, it becomes difficult to search any particular API without using browser provided search utility. Whenever I or anyone will be using this API, they will have a specific need, and a long README without many intrapage links makes it difficult.
The content is all there but things needs to be re-arranged and indexed with intrapage hyperlinks. For example in APIs section, we can link each API to its definition. This will make things easier to look and use.