From: Gavin Sinclair <gsinclair@...>
Date: 2005-10-14T19:26:56+09:00
Subject: Re: Why Write Ruby Docs? (was Re: [SUMMARY] Text Image (#50))

Kev Jackson wrote:

> If I could get paid to write docs I'd be all over it like something all
> over something else.  But if someone could point to some area that needs
> documenting I'd be more than happy to help - I was a technical author a
> few years ago, and I have contributed code and docs to several open
> source projects (mainly Java), I just didn't realise that more hands
> were needed - please push links etc to me I'll help out with doco

Hi Kev,

Documentation of core and library classs is written in the source code
(be it C or Ruby).  Thus to contribute, you want to avail yourself of
(anonymous) CVS access (it's easy).  Then you edit files, create a
patch, and get it committed.  That last step has been the problem in
the past; mea culpa.  Suggested process: email the patch to me and/or
James Gray (sorry, James!).  Bug me mercilessly if nothing's being
done.

Anyway, then it ends up in Ruby itself and appears on ruby-doc.org
hopefully soon after.

Any questions, just email.

Cheers,
Gavin