Devise a standard for additional docs
It seems that at present NuDoq only works with docs generated from summary comments. It would be great if developers could add additional documentation to their NuGet packages, in Markdown, maybe below a Docs folder?
Nathanael Jones commented
Pulling Readme.md files from github would be fantastic. We're forced to put nearly everything there anyway.
Ian Johnson commented
I really like this idea, but I would worry about including documentation mark downs in the standard package. People really only want the binary & xml, they don't want to carry all the extra html with it.
What if there was a standard naming convention
Combine that with a tool to scrape documentation from example project and you could have your API and example documentation scrapped from living documents.
Daniel Cazzulino commented
This is a great idea :)
We'd need to devise a way to distribute documentation at the project level too (that's above the package level, for multi-package projects like Autofac).
But maybe package-level doc should be enough for the vast majority