Re: [doc] User Manual Suggestion

["J. Bruce Fields" <bfields@fieldses.org>]

On Fri, Apr 24, 2009 at 02:32:36PM -0400, David Abrahams wrote:
>
> On Apr 24, 2009, at 1:38 PM, J. Bruce Fields wrote:
>
>> On Fri, Apr 24, 2009 at 10:18:15AM -0500, Michael Witten wrote:
>>> I think that we've already got that tutorial-esque style covered (I
>>> haven't read it in a while):
>>>
>>>    http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html
>>>
>>> However, the User Manual should make a Mathematician happy.
>>
>> I'm all for making mathematicians happy.  But, again, help?:
>>
>> 	- Specific examples?
>> 	- Patches?  Please, patches?
>> 	- Suggested text?
>> 	- Suggested outline?
>>
>> There's no shortage of high-level ideas.  What there's always a need  
>> for
>> more of is people willing to submit patches, respond to review, etc.
>
>
> I'll probably try to write something myself once I figure this stuff  
> out.

That would be great, thanks.  Several people have gone off and posted
their own tutorials someplace, and that's fine, but it would be
especially helpful if you could contribute to the actual Documentation/
directory.  That may mean arguing with people and making compromises.
But it also means the results will be distributed with git, will be
integrated with other git documentation, and will get first-class
technical review.

I'd also encourage incrementally improving existing documentation where
possible instead of starting over from scratch.  But having broken that
rule myself a couple times I'm hardly in a position to insist.  If you
must start over, at least think about how to replace or fit it in with
existing documentation.

--b.