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

Re: A documentation to-do list

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Nov 22, 2006, 09:57 UTC
Message-ID
<Pine.LNX.4.63.0611221044180.30004@wbgn013.biozentrum.uni-wuerzburg.de>
In-Reply-To
<6efbd9b70611211713y4a1574adje48622f7bab6d702@mail.gmail.com>
Hi,
On Tue, 21 Nov 2006, Chris Riddoch wrote:
> 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 have a request, which is not about _what_ to document, but _how_. People often complained about the bad introduction into git, pointing to http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart for a "way better" tutorial.

It would be really, really easy to just copy that, and describe git instead of hg. (There is no mention of a license there, so that may not be allowed, but then, it is too short and obvious to be copyrightable, isn't it?) You will find that git commands are way shorter!

So, finally my request: we should _organize_ the documentation such that your average Joe Programmer is able to get started with git in 1 minute.

If she is interested in more subtle operations, then she should have a technical overview such as "Branching and merging with git", maybe a little stripped down to leave complicated (but for normal work uninteresting) issues out. With a pot of steaming coffee.

Finally, for complicated issues, there is Documentation/technical, the man pages, the source, and the git list (in that order).

Hmmm?

Ciao, Dscho

Previous: Alan ChandlerNext: Michael K. Edwards
Message 4 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.