Foster Docs

[sebastianwhiffen]

Really enjoying this framework as a c# developer, but it could seriously use some docs!

Two things that I would be appreciative of as a user would be:

1. a wiki containing some of the usual stuff like 'getting started' and a description of anything exposed to the public API
2. XML docs so when I hover over a Foster method or class I can tell what its intended use is

I'd be more than happy to commit these changes myself if there was some interest in it : )

The XML comments are straight forward enough, but perhaps a group decision should be made on how we present the official docs

[sebastianwhiffen]

My bad on the XML comment part

took a look at the source and it seems like there's already comments, not sure why my editor isn't showing them?

[NoelFB]

Interesting... I actually wonder if they're somehow not being included in the NuGet package? I'll have to take a look!

[sebastianwhiffen]

I was able to fix it by adding:
GenerateDocumentationFile = true
to the csproj file, clearing my nuget cache and then re-packing the file to somewhere on my local. PR

this XML flag would also be needed for ttps://dotnet.github.io/docfx/ if you were to decide you wanted to use that

[NoelFB]

Yeah I would like to make a simple static site that uses the XML docs (which could also be improved). There's one specifically for dotnet that might be a good choice: https://dotnet.github.io/docfx/

[sebastianwhiffen]

maybe set out a 'standard' you'd like public methods to have for their comments, like a minimum requirements so they don't get sloppy if someone comes to write new / re-write old ones