SteamKit icon indicating copy to clipboard operation
SteamKit copied to clipboard

Online source documentation

Open voided opened this issue 10 years ago • 6 comments

It'd be nice if we had source code documentation available online somewhere, similar to the .NET reference source.

https://github.com/KirillOsenkov/SourceBrowser

I think we could use github pages for hosting as well.

voided avatar Oct 29 '15 23:10 voided

Sounds good. Any idea on how to keep it up to date automatically, or would we have to manually regenerate every release?

Netshroud avatar Oct 29 '15 23:10 Netshroud

Perhaps piggyback off either Travis or Appveyor and have them build and push the documentation on commits.

There's a nuget package that would allow us to pull in the HtmlGenerator binary pretty easily.

voided avatar Oct 29 '15 23:10 voided

https://readthedocs.org/ maybe? They support regenerating with webhooks.

xPaw avatar Oct 30 '15 08:10 xPaw

It turns out that static page hosting isn't enough, we have to run the search webservice as well.

It's not a huge ask, but it does make updating more complex.

voided avatar Nov 01 '15 19:11 voided

I went and put up the service and generated files to get a feel for what it'll be like: http://steamkit.voided.me/#SteamKit2

voided avatar Nov 03 '15 01:11 voided

Looks good, would be nice to replace .NET/Microsoft logos though.

xPaw avatar Nov 03 '15 08:11 xPaw