Add documentation to NuGet package and/or have updated easy to find online documentation #57

Closed
LJNielsenDk opened this Issue Sep 25, 2013 · 2 comments

Comments

Projects
None yet
2 participants

Add documentation to NuGet package and/or have updated easy to find online documentation.

Member

stakx commented Jun 3, 2017

Hi @LJNielsenDk, it has been a long time since you posted here. Are you still interested in this issue? If so, please report back sometime during the next two weeks or so; otherwise I'll close this issue. Some quick feedback and questions:

Add documentation to NuGet package

What exactly did you have in mind?

The NuGet package includes the API documentation in the form of XML documentation comments. These are accessible via Visual Studio's IntelliSense and/or the Object Browser tool window.

It would be somewhat unconventional to include, say, a PDF or CHM file in the NuGet package. Full documentation is usually found online these days.

have updated easy to find online documentation

Regarding "easy to find", the readme page points to the Quickstart guide as well as the API reference documentation on NuDoq, as well as to some blog posts. Is that sufficient? Or do you have suggestions how the status quo could be improved?

Regarding "up-to-date", the documentation on NuDoq is indeed out of date. This is being tracked in #354.

stakx added the documentation label Jun 5, 2017

Member

stakx commented Jun 15, 2017

I'm closing this issue for now, since it's not exactly clear what is being asked for. I'm happy to reopen this issue if you have further comments or suggestions!

stakx closed this Jun 15, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment