Re: Documentation

[Jesse van den Kieboom <jesse icecrew nl>]

Guilhem Bonnefille schreef:
> Hi,
>
> I started a new topic branch for hosting devel around help system in gitg:
> http://github.com/guyou/gitg/tree/doc
>
> Currently, only the real minimal stuff is in place:
> - the smallest document,
> - a menu entry.
> Next task will be to increase documentation. Any "help" is welcome.
>   
Cool! I don't have much time, and I think if I find some time for gitg, 
I would like to spend it on bugfixing and features for now (I think help 
is important, but I need to prioritize).
> Doing this, I noticed that macro I used are GNOME_*.
> Is it acceptable for gitg to increase dependency to gnome?
>   
I don't think we need any specific dependency (in terms of configure 
stuff) for this. There isn't really any dependency on gnome as far as I 
know. For distribution dev packages there would be a dependency on 
gnome-doc-utils which is perfectly fine.


Jesse
> 2009/5/1 Jesse van den Kieboom <jessevdk gnome org>:
>   
> > Guilhem Bonnefille wrote:
> >     
> > > Hi,
> > >
> > > Current gitg has many many features.
> > > I have to admit that I discovered many of them reading the code (the
> > > last one is the ability to d'n'd files to export specific versions).
> > >
> > >       
> > New features such as these can also be found in the NEWS file/
> >     
> > > So, I think it could be really interesting to start documenting gitg.
> > > I propose to use the Gnome documentation scheme. I can found the
> > > gnome-hello project has reference:
> > > http://git.gnome.org/cgit/gnome-hello
> > > I also know that Łukasz Jernaś had started such thing for giggle:
> > >
> > > http://github.com/deejay1/giggle/tree/b7f689a4e81d7e4283df23558f7e26fa821cb8ca/help
> > >
> > > What do you think about such task?
> > >
> > > If you're agree, it seems that user manual is built inside the "help"
> > > directory. Do you have an other preference?
> > >
> > >
> > >       
> > Of course, I'm all for having nice help, but I'm just to busy with other
> > things and if I do find time to work on gitg, it will probably not be
> > writing help pages :) Feel free to start the infrastructure and pages.
> >
> >
> > Jesse
> >
> >     
>
>
>
>