We made a recent change to make it easy to update the NuGet documentation. In this post, I’ll cover what the change was, why we made it, and how it makes it easier to contribute to our documentation. Our docs run as a simple ASP.NET Web Pages application that renders documentation written in the Markdown format. The Markdown text is not stored in a database, but live as files that are part of the application source code. That allows us to use source control to version our docs. We used to host the source for the docs site...
It’s a common refrain you hear when it comes to documentation for open source projects. It typically sucks! In part, because nobody wants to work on docs. But also in part because good documentation is challenging to write. What is good documentation in the first place? The following is a list of some qualities that make for great documentation. This list is by no means complete. Good docs are… Written for the right audience Comprehensive and accurate Easily browsable and searchable Written in...