Add supported help XML tags to contributing/documentation

[cake-build]

Add supported help XML tags to contributing/documentation

[devlead]

This is sorted right?

[gep13]

@devlead Personally, I still think we need to come up with a recommendation, to what "should" be included in a Summary documentation section, i.e. include <see> with external links, to either source code/help documentation for associated tool/extension.

Once we know what that recommendation is, we can add it to the documentation page, and then add to all internal aliases, and recommend external addin's do the same.

[daveaglick]

Wyam supports all recommended XML comment tags so the question now is one of convention. What tags would you expect or like to see from addin authors when documenting their addins?

[devlead]

Issue covers both addins and core, perhaps it's a matter what's missing from
http://cakebuild.net/docs/contributing/documentation
?
@cake-build/team thoughts?

[gep13]

Yes, this issue was really about providing guidance for what a "good" summary section looks like.

I tend to use something like this:

And this issue was really about getting that into our documentation so that other places could do somethign similar as well for consistency.

[devlead]

An thought tough, could parts of code like that be auto generated for addins? Something like what I inferred in issue #184?

[pascalberger]

Instructions how to add an addin to the build are now part of the addin details page. For creating best practices how to write documentation I've created #1241.