On 09/24/2010 01:18 PM, Brian Aker wrote:
> Hi!
> 
> So the wiki really doesn't seem to be working for documentation. It lacks 
> comments, which are super useful, and it is just one big long list. 
> 
> A few thoughts:
> 1) Docbook sucks to write in.
> 2) I personally would be far more inclined to write via bzr (and have it 
> shipped with the code). 
> 3) Doxygen is not for user level documentation.
> 
> I've had a couple of folks who have been willing to work on this, but the 
> above pretty much means nothings happens. If I start writing on this it will 
> be POD (human editable, has tools, etc...). YAML would be fine as well, but 
> the layout for it is sort of odd. 
> 
> None of this solves the comment problem. PG's documentation seems ok, as does 
> MySQL's.

As a follow up, I should add that the documentation entry point is
docs/index.rst - and that you should assume Sphinx 1.0 when writing docs.

_______________________________________________
Mailing list: https://launchpad.net/~drizzle-discuss
Post to     : [email protected]
Unsubscribe : https://launchpad.net/~drizzle-discuss
More help   : https://help.launchpad.net/ListHelp

Reply via email to