From: Rob Muhlestein Date: 2007-01-04T03:55:05+09:00 Subject: Re: Any projects need rdoc documentation help? Rob Muhlestein wrote: > Jay Bornhoft wrote: > > As part of my effort to become increasingly more involved in the Ruby > > community, I would like to volunteer my efforts towards any rdoc - > > documentation requirements. > > This touches on two broader topics as well 1) a master prioritized > TODO/Ruby list other than the 'project want ads' on RubyForge and 2) > the state of the rdoc tool itself. A casual search of google doesn't > reveal anything immediately. > > Seems like we could use some top priorites for the new year laid out > and focus efforts on those, but probably a little oversimplified given > the scope and number of Ruby projects out there to be done. > > Personally I'd like to see RAA/RubyGems registry a-la CPAN-ish stuff > materialize more this year with focus on preventing filename clashes > and namespace registration along with self-documenting code that > produces web site documentation just by uploading it. I don't see that > in RAA currently, but there is a lot going on out there. And then we > could build on that with a community-based test grid and ratings, that > would be cool. > > So far I find rdoc far from from the Perl POD or even JavaDoc I grew > accustomed to. I realize there are other priorities. I do wonder why > POD wasn't just stolen verbatum. It didn't seem 'broken' to me. People > write entire books in POD. Please correct me, but I don't believe rdoc > is to that level yet. Would be good to get it there. I'll have to dig > up the rdoc 'project team' info, if any and take a look at todos for > the rdoc tool itself. Ok, I confess I skipped over the "Writing CGI Scripts" section of the pickax and missed the stuff about RDoc Templates, which seem to cover anything POD or JavaDoc every wanted and more with ability to extend, so I think potential all-in-rdoc book writers might be covered or easily could be without too much additional work. We will really know rdoc is up to snuff when O'reilly agrees on a set of RDoc templates to use for rdoc Ruby publications, like they do for Perl. Anyone know if such an undertaking/dialog has begun?