[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [MiNT] Kernel documentation shortcomings



Am Montag, den 23.08.2010, 16:05 +0200 schrieb Alan Hourihane
<alanh@fairlite.co.uk>:


> Sure. We want ALL the docs.

I didn't meant to destroy any information ;) 
 
>> Of course we could write an converter, from wiki to man page... but
>> maybe it would be better if a small script translates them to wiki
>> content?
> 
> Whatever works for you to get the stuff into the wiki. I'm easy.

I'm not talking about an one time script... I'm talking about the place
where the documentation should be maintained.
The programmers must accept/decide how/where the kernel will be
documentet... and I remember many people said that it is essential to
keep documentation where the source is ;) That's also my point of view.
If we can keep documents (in their current form) in the kernel - that's
good. That means we don't need to import into the wiki, export them,
convert them, place them into the release... We could simple take the
up-to-date docs from freemint trunk ;) 

Importing these docs to the wiki is another part of the documentation
process then... (not that much work).

I vote for docs integrated into the sources. 

Greets,
m0n0