Create online documentation from docstrings

[1kastner]

I see a good documentation in some interfaces, e.g. the IHystrixCommand. Now I wondered whether it is possible to create an online documentation which is accessable for everybody. If so, a link the the global README.md would be great for doing quick and good research. Hystrix Javadocs are an example of what I could imagine. Now the question is, which exact standards did you comply with? Asking seems faster then reverse-engineering here, but I guess it is XMLDOCTAGS which could be used for creating a documentation with sandcastle.

[markvincze]

Certainly a good idea, but we'd have to go over our xml docs and clean them up/add them where they are missing.

I never found Sandcastle too convenient (in my experience it was really convoluted to set up), but I really like DocFX, it's pretty easy to set it up, and the generated documentation by default looks like this: https://markvincze.github.io/Stubbery/api/index.html

[1kastner]

That looks really great! Good that you have the experience and DocFX seems like a really nice choice! I think that if once docfx is set up, the missing xml docs can be added by pull requests quickly.

[1kastner]

It seems possible to integrate github projects into the documentation, see e.g. the discussion here. A (not working) example of how to add DocFX to appveyor can be found e.g. here. I guess the easiest way is to privately fork this repository and set up the appveyor.yml so that it works and then add those new lines to the current configuration file. Does that procedure sound good to you?

[markvincze]

@1kastner in progress here: https://github.com/Travix-International/Hystrix.Dotnet/pull/25