From: Gavin Sinclair <gsinclair@...>
Date: 2003-07-29T18:20:47+09:00
Subject: Re: Documentation for standard library -- what format?

> [...]
>
> Again, I
> ask because I'd like to contribute (if contributions are
> sought), but I'm not sure what to contribute to...
>
> William Webber


Just a quick note in addition to what James wrote.

There is an ongoing, though not very active, project to document the
standard libraries in the source code in RDoc format.  I am the de facto
project leader for this, and what discussion of it there is takes place on
the ruby-doc@ruby-lang.org mailing list.  You sound like a good candidate
for adding yourself to this list :)

Hop on over to www.ruby-doc.org and follow the instructions to sign
yourself up.

And to answer your question about what to contribute to, start by
converting the RD documentation you've found into RDoc.  Post your results
on the ruby-doc mailing list, and we'll discuss style, etc.  That'll keep
us going for a while (I think there's a fair bit of RD documentation in
there).  Then basically we tackle each new file based on what appears easy
and/or important, using multiple sources (Pickaxe, Nutshell, whatever...)

Thanks very much for your interest!

Cheers,
Gavin