20 Jan 2010 06:26
Re: Best way to contribute Mono documentation?
John Feminella <johnf.pub <at> distb.net>
2010-01-20 05:26:54 GMT
2010-01-20 05:26:54 GMT
Thanks very much for that info, Jonathan; it was immensely helpful. I hope you won't mind if I follow up with a few clarifying questions: > However, if you have a mono checkout you can instead edit the XML > documentation directly. For example, Mono.Options XML documentation is > at: > > http://anonsvn.mono-project.com/source/trunk/mcs/class/Mono.Options/Documentation/en/ * Are these source and not generated files? That is, it was my understanding is that things in a path matching **/Documentation/** are generated by an external documentation-generation tool. If someone later updated the source, wouldn't that cause problems with the resulting generated files? Is this a mistaken view? So, to me it sounds like the take-away conclusion to draw from your earlier e-mail are: * Don't use `monodoc --edit`. * Do use `mdoc update` + documentation stubs. * Maybe use inline XML + `mdoc update -i MyType.xml`. * Chug out docs by filling out the stubs mdoc generates. You can use `mdoc export-html` to see how it all looks once you're making progress. * Find an assembly or two (or perhaps even an ancillary project like Cadenza) and just jump right on it, mailing relevant patches to the(Continue reading)
RSS Feed