Re: [PATCH] Documentation: add a README file

Yann Droneaud [off-list ref] writes:

There were no indication about how to write documentation
in SubmittingPatches.

I would agree that is probably the right place for it if we were to
add insns/hints.

Le jeudi 21 mars 2013 à 10:39 -0700, Junio C Hamano a écrit :

Yann Droneaud [off-list ref] writes:

quoted

There were no indication about how to write documentation
in SubmittingPatches.

I would agree that is probably the right place for it if we were to
add insns/hints.

But it will be difficult to find the place to put a note about
how to write the documentation.

Anyway, having a README at the Documentation/ level could also help to
explain what to be found in this directory:
- user-manual
- howto
- technical
- RelNote
- SubmittingPatches
- CodingGuidelines
- etc.

Regards.

-- 
Yann Droneaud
OPTEYA

Yann Droneaud wrote:

Anyway, having a README at the Documentation/ level could also help to
explain what to be found in this directory:
- user-manual
- howto
- technical
- RelNote
- SubmittingPatches
- CodingGuidelines
- etc.

A Documentation/README or Documentation/INDEX in the spirit of Linux's
Documentation/00-INDEX could be interesting if it does not bitrot
(unlike Linux's 00-INDEX).  Presumably that means it would have to be
pretty brief.

Thanks,
Jonathan