[MonoDevelop] MonoDevelop documentation

Fawad Halim fawad@fawad.net
Sun, 30 May 2004 23:29:25 -0500

	I've imported a docbook documentation skeleton to subversion 
monodevelop under the directory 'help'. However, there is some 
disagreement as to what format we should be documenting the app under. 
Here are the 3 options we've got for this (stolen from Todd's email on 
the topic):

1) Write docbook docs and just deal with it (use yelp/khelpcenter as 
help browser).
2) Write xhtml docs and use monodoc as the help browser
3) Create yet another help browser and use a different format.

I'm partial to "2" myself (yelp sucks quite badly, IMHO). Todd has 
indicated that he'd prefer the docs to be similar to that of other GNOME 
apps, being that MD is a GNOME app (hence option "1").

I'd like your guys' opinion on the topic. What help browser should we be 
shooting for (yelp, monodoc, or other)? What documentation format should 
we be using (docbook xml, xhtml)? The /help import is quite bare at this 
point, so I have no problem removing that in favor of some other 
documentation format.