Where do I stick development documentation?
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Aug 11, 2010, 22:49 UTC
- Message-ID
- <AANLkTi=dS1DYJ3MB-Du34sVPy8Qw8VNck=Lx54DtSfO0@mail.gmail.com>
There's some documentation aimed at developing that I'd like to see / write in Git at some point.
Developing:
* How to work with Gettext
* How to write portable code, i.e. constructs to avoid in C / shell
script etc (these keep coming up).Translators:
* How to deal with gettext / submit po files / keep them up to date
etc. * Core git concepts (that need to be translated), maybe I could
adopt the gitglossary to this task, but it'd need to be a bit
more structured, i.e. describe core data concepts first, then
some other terms. Actually, on that point, do we have documentation that describes
git's data model in one place? I.e. everything from blobs to
trees, how raw commit objects etc. look. Something like "Git for
computer scientists".The problem is that I don't know where to put these. I like idea of them being man pages, maybe gitdev-gettext.txt, gitdev-code-portable.txt or something like that?
The only thing like that currently it Documentation/{SubmittingPatches,CodingGuidelines} and t/README.