Ruby on Rails documentation

I am new to Ruby on Rails. I am very very pleased with it
thus far.

While the videos showing RoR in action were tremendously
helpful, I am somewhat dissapointed by the available
documentation.

Most, if not all, of the functions and classes are not
completely documented or exemplified.

I realize that the documentation is rdoc-generated, but
I was wondering if there was any effort underway to improve
the quality and depth of the documentation.

Thank you

-v

vsharma wrote:

I am new to Ruby on Rails. I am very very pleased with it
thus far.

While the videos showing RoR in action were tremendously
helpful, I am somewhat dissapointed by the available
documentation.

Most, if not all, of the functions and classes are not
completely documented or exemplified.

I realize that the documentation is rdoc-generated, but
I was wondering if there was any effort underway to improve
the quality and depth of the documentation.

Thank you

-v

are you talking about http://api.rubyonrails.com ?.. Because I think
it’s pretty good.
Anyway, you should really consider buying a rails book:

http://www.rubyonrails.com/docs

regards,
rolando.-

Rolando A. wrote:

completely documented or exemplified.
are you talking about http://api.rubyonrails.com ?.. Because I think
it’s pretty good.
Anyway, you should really consider buying a rails book:

http://www.rubyonrails.com/docs

regards,
rolando.-

If there are specific parts of the documentation that you feel are
lacking let us know. We can only improve things if we know what needs
work.

Matthew M.
blog.mattmargolis.net

There is also the www.railsmanual.org which has some search
functionality.

-NSHB

On 8/22/06, Rolando A. [email protected] wrote:

completely documented or exemplified.
it’s pretty good.


Kind regards,

Nathaniel B.

Inimit Innovations Inc.
http://inimit.com

vsharma wrote:

I realize that the documentation is rdoc-generated, but
I was wondering if there was any effort underway to improve
the quality and depth of the documentation.

Thank you

-v

Other people have the same opinion as you do, and those other people
reside over at http://blog.caboo.se. You can find information about
their (well-funded by now) documentation project at
http://caboose.stikipad.com/documentation.

It is a work in progress, but these are top-notch rails developers at
the wheel of the thing, so you can expect at least SOMETHING good will
come from them and their $15K bucks :wink:

Regards,
Henning K.