git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Documentation: add a README file

From
Yann Droneaud <ydroneaud@opteya.com>
Date
Mar 21, 2013, 21:59 UTC
Message-ID
<1363903193.6289.57.camel@test.quest-ce.net>
In-Reply-To
<7vzjxwabzv.fsf@alter.siamese.dyndns.org>
Le jeudi 21 mars 2013 à 10:39 -0700, Junio C Hamano a écrit :
Show 8 quoted lines
> 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.
>

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
Previous: Yann DroneaudNext: Jonathan Nieder
Message 7 of 8 in “Documentation: add a README file”
  1. Documentation: add a README fileYann Droneaud, Mar 21, 2013
  2. Junio C HamanoMar 21, 2013
  3. Yann DroneaudMar 21, 2013
  4. Junio C HamanoMar 21, 2013
  5. Junio C HamanoMar 21, 2013
  6. Yann DroneaudMar 21, 2013
  7. Yann DroneaudMar 21, 2013
  8. Jonathan NiederMar 21, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.