Re: Best way to contribute Mono documentation?

On Tue, 2010-01-19 at 21:32 -0500, John Feminella wrote:
> * Are these source and not generated files?

Yes (these are source) and No (they are ALSO generated).

>  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?

Behold the power of XML!  Or something.

Both humans and mdoc process the *same* XML files.  mdoc will add and
remove <Type/> and <Member/> elements from the XML (as types and members
are added and removed from the assembly), and a whole host of other
things.

The *only* elements that should be edited by hand are the //Docs
elements, and mdoc is written to not change the contents of these nested
elements [0].

In general, it seems to work.

> So, to me it sounds like the take-away conclusion to draw from your
> earlier e-mail are:
> 
> * Don't use `monodoc --edit`.

Yes.