[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: GDP: documentation guidelines
From: |
John Mandereau |
Subject: |
Re: GDP: documentation guidelines |
Date: |
Sun, 23 Sep 2007 16:52:22 +0200 |
Le dimanche 23 septembre 2007 à 16:38 +0200, Juergen Reuter a écrit :
> I would expect the contents of README.txt to be part of the online
> documentation and therefore available at:
> http://lilypond.org/doc/v2.10/Documentation/user/README
> However, obviously this file is not generated from README.txt or at least
> not put into the documentation out directory. Or is it available under
> some different URL?
There's no need to add README.txt to the compiled docs, as we can
directly refer to the sources:
http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=Documentation/user/README.txt;hb=lilypond/gdp
where f is generally the file path and hb is the branch name.
> I also strongly suggest to put a link to this resource on some prominent
> page, maybe on:
> http://lilypond.org/web/devel/participating/
> Otherwise, I think this file is too well hidden to be found by occasional
> documentation writers.
Why not adding it on documentation-adding and "Developers
resources" (linked from Documentation index)?
Cheers,
John