Re: Ruby Docs with annotations and searching

On 5/17/06, Conor Hunt <[email protected]> wrote:
> I recently released a new version of my Rannotate application that
> allows for annotations and searching of RDoc generated documentation.
> This version has many changes, a new interface and lots of new
> features.
>
> Have a look here:
> Ruby 1.8.4 Docs - http://ruby.outertrack.com
> Rails Docs - http://rails.outertrack.com
>
> It is basically a custom RDoc YAML generator and a Rails application
> that work together. The rubyforge project is at -
> http://rannotate.rubyforge.org

Hi Conor,

This project looks really cool, and I'm trying to better understand
what it does. Can you please tell me:

1. What purpose does YAML serve for Rannotate?

2. Does Rannotate use the Ruby built-in RDoc modules to do its job?

3. Do you see the RA-Ruby site (http://ruby.outertrack.com/) as a way
to help get more docs into the official Ruby source? That is, do you
see the maintainer of that site gradually trying to get some of the
more valuable "comments" into the Ruby source code files?

3.1. Do you see any easy way to help automate the process of
selectively merging choice RA site comments into RDoc in the source
code files?

> I think that the ruby-lang site could benefit greatly from using this
> instead of the current combination of HTML docs and wiki.

Regarding the HTML, are you referring to http://www.ruby-doc.org/core/
and http://www.ruby-doc.org/stdlib/ ?

Also, regarding the wiki, word on the street is that we'll soon see a
major upgrade to the official Ruby wiki (see
http://wiki.rubygarden.org/ ) a la RuseWiki.

Thanks,
---John