Publishing documentation is yet another task on the long list of things to do as a library author. I had an idea – what if that was just done automatically once you push your package to Nuget.org? That’s why I created NuDoc.NET.
With C# we got XML comments that are in the code which makes it a lot easier to keep the docs in sync with the code. The problem? The XML comments are often only used for intellisense. The comments are sitting there, providing explanations and comments on API usage but they never make it to the documentation site.
NuDoc.NET is an effort to make all of the effort that has gone into the XML comments available outside of the intellisense popups. It downloads NuGet packages on demand, extract the documentation and make it available.
In the past we had to set up our own source code repositories, build servers and deploy pipelines. They are all commodities now where there are ready-to-use cloud platforms. Documentation should be the same. Let the developers focus on creating the code and the docs. The building, publishing and hosting can be standardized.
Please try it out yourself on see what the packages you use look like. If you have any feedback, please head over to our GitHub Discussions.