Early Preview
About NuDoc.NET
Writing documentation is boring. Keeping documentation in sync with the code is even more boring. 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. We download NuGet packages on demand, extract the documentation and make it available.
Feedback, ideas and general thoughts are welcome. Please share your thoughts at our GitHub Dicussions
If you have any feedback, comments, requests or just want to tell us if this might be useful for you, please head over to our GitHub Dicussions.
Sample Docs
Sustainsys.Saml2
Sustainsys Saml2 library is widely used to enable Saml2 authentication for ASP.NET Core applications.
Duende.IdentityServer
The legendary IdentityServer OpenID Connect and OAuth SDK, nowadays developed and maintained by Duende Software. This is an example of where the cross-linking features of NuDoc.NET helps. Looking at the docs for their DefaultAuthorizationCodeStore you can easily navigate to the model docs, which are from another package.
NodaTime
NodaTime is an example of a library that has extensive XML-docs. As we're working to support more features on NuDoc.NET, these docs will just look better and better.