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

Re: A documentation to-do list

From
Junio C Hamano <junkio@cox.net>
Date
Nov 22, 2006, 01:33 UTC
Message-ID
<7vslgcw9ii.fsf@assigned-by-dhcp.cox.net>
In-Reply-To
<6efbd9b70611211713y4a1574adje48622f7bab6d702@mail.gmail.com>
"Chris Riddoch" <riddochc@gmail.com> writes:
Show 11 quoted lines
> Hi, everyone.
>
> Having decided to take it on myself to improve Git's documentation, I
> asked on #git if people had particular things they felt I should focus
> on.  I also was prompted to put up a page on the wiki to make my to-do
> list public.
>
> So, I present:  http://git.or.cz/gitwiki/Documentation_To-Do_List
>
> Add your favorite, specific, lack-of-documentation or badly-described
> annoyance here!
Thanks.

I would not likely to be writing the updates because I am not a good writer myself, but if there are things that need to be explained, both behaviour-wise and intent/design-wise, I am willing to help this effort.

Aside from lacking minor details here and there I think the largest problem in the current documentation set is the organization, though.

Previous: Chris RiddochNext: Alan Chandler
Message 2 of 6 in “A documentation to-do list”
  1. Chris RiddochNov 22, 2006
  2. Junio C HamanoNov 22, 2006
  3. Alan ChandlerNov 22, 2006
  4. Johannes SchindelinNov 22, 2006
  5. Michael K. EdwardsNov 22, 2006
  6. lamikrNov 22, 2006

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.