Re: Updating our own docs

[Shaun McCance <shaunm gnome org>]

On Sat, 2006-09-23 at 17:15 +0100, Joachim Noreiko wrote:
> Since now is the quiet time of the cycle, I figure we
> should look at our own documentation -- the GDP
> Handbook and the Style Guide...
> 
> I'm going to start going through the bugs currently
> files in these.
> (http://bugzilla.gnome.org/browse.cgi?product=gnome-docu)
> Please file bugs if there are things you think I
> should look at.

Thanks, Joachim.  As I've mentioned before, I would like
to move these documents to gnome-devel-docs, but do feel
free to make commits in the current location until I do.
I will cvs remove the old files after the move.

Changes in actual recommendations or practices (as opposed
to type fixes, markup improvements, etc.) should be discussed
on the list, to allow everybody to give their input.  You can
initiate any necessary discussions.

> Brent, you mentioned that while we wait for
> Library.g.o to be complete, you could improve the
> presentation of the handbook and style guide:
> http://developer.gnome.org/documents/style-guide/
> It doesn't have to be pretty, but hiding the GFDL guff
> and splitting it into several pages would be a huge
> help.

I would really like us to build these with the gnome-doc-utils
stylesheets.  I've just added a gnome-doc-html script which
should make it easier to build HTML from DocBook.  Any style
niggles can be addressed.  Just email gnome-doc-devel-list.

> Also, is the document at that URL magically updated
> when commits are made to CVS, or would I need to bing
> a human or a machine, and if the latter, who or what?

All of these documents are generated by human beings and put
manually onto the web server.  Hopefully we'll get library.go
running for 2.18.  I should probably do an IRC hackfest to get
things moving.

--
Shaun