From: John Conrad <john.emerson.conrad@...>
Date: 2006-05-10T11:12:35+09:00
Subject: Re: Ruby documentation discovery

------=_Part_58721_29664711.1147227150883
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

On 5/9/06, Dave Howell <groups@grandfenwick.net> wrote:

> Huh. I got so tired of trying to play "guess the spelling and
> capitalization" with ri, along with the bonus "oh, did rdoc even get
> run for that?", that I wiped the entire directory. I vastly prefer
> being able to scroll through an HTML list, and use hyperlinks.
> Hyperlinks! Bliss!


It's not that I don't like hyperlinks - I love them! That's what I meant
when I said I was spoiled by the emacs style of self-documentation. However=
,
hyperlinks are most useful, IMO, if you are able to initally jump to a
specific starting point. Rather than always starting at the root and
clicking down from there.

>
> Fortunately, I have Ruby. I wrote a program (RDC) that generates HTML
> documentation via Rdoc for, well, whatever it can find. Gems mostly
> arrived with HTML documentation already built for them. RDC doesn't
> regenerate existing documentation. It checks the Ruby core, the gem
> dir, and the site dir. Each component gets its documentation stored in
> its own subtree, following the gem structure, more or less. Then RDC
> builds (or rebuilds, as needed) a master index page that links to all
> the other documents, thus providing the critical missing "Home Page"
> for Ruby HTML documentation.


Have you released RDC to the public? If so, could you provide a link? It
sounds useful.

Regards,
John Emerson Conrad

------=_Part_58721_29664711.1147227150883--