Re: [PATCH] Documentation: add a README file

[Junio C Hamano <gitster@pobox.com>]

Junio C Hamano <gitster@pobox.com> writes:

> Yann Droneaud <ydroneaud@opteya.com> 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.

I take it back.

SubmittingPatches does not, and I do not think it should, discuss
any issue that is programming language specific.

We already have a dedicated section for documentation updates in
CodingGuidelines, though.

 Documentation/CodingGuidelines | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index b1bfff6..7e4d571 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -237,6 +237,9 @@ For Python scripts:
 
 Writing Documentation:
 
+ Most (if not all) of the documentation pages are written in AsciiDoc
+ and processed into HTML output and manpages.
+
  Every user-visible change should be reflected in the documentation.
  The same general rule as for code applies -- imitate the existing
  conventions.  A few commented examples follow to provide reference