I suggest you ...

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?

27 votes
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
  • facebook
  • google
    Password icon
    I agree to the terms of service
    Signed in as (Sign out)
    You have left! (?) (thinking…)
    Mark RendleMark Rendle shared this idea  ·   ·  Admin →

    3 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      Submitting...
      • Nathanael JonesNathanael Jones commented  · 

        Pulling Readme.md files from github would be fantastic. We're forced to put nearly everything there anyway.

      • Ian JohnsonIan 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

        PackageName.nupkg
        PackageName.Documentation.nupkg

        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 CazzulinoDaniel 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

      Feedback and Knowledge Base