Documentation for rails


#1

I’m trying to convince a co-founder of the startup I’m working on that
rails
is the new black, or possibly the next sliced bread. Does rails ship
with
doc, or the API? I can’t even figure out how to download it from
api.rubyonrails.com, or if that’s possible. When I look in
C:\ruby\lib\ruby\gems\1.8\gems\rails-1.1.2\doc I see nothing of use. I
have to admit he’s got me on this one compared to javadoc. He keeps
looking
at the classes I’m using (ajax scaffold gen stuff, and others) and
asking me
how he could know where the file for each class is, and what arguments
they
take, and if there’s any doc. I’m having a hard time answering him.

Can anyone point out where a non-online version of the doc for the Rails
API
is? Does rails come with the API or doc? Can the API files be
downloaded?
Do you have other suggestions I can give him regarding researching
different
classes and their use without googling, or even learning ruby? Any help
is
appreciated. Thanks.

Thanks,

Eric


#2

On May 7, 2006, at 11:21 PM, Eric B. wrote:

Can anyone point out where a non-online version of the doc for the
Rails API is? Does rails come with the API or doc? Can the API
files be downloaded? Do you have other suggestions I can give him
regarding researching different classes and their use without
googling, or even learning ruby? Any help is appreciated. Thanks.

From your command line:

gem rdoc --all
gem_server

This will launch WEBrick on port 8808, serving all of the rdoc
documentation for every gem you have installed (that has rdocs).

-Brian


#3

If your on windows there is an excellent CHM available at

http://delynnberry.com/files/rails-documentation-1-1-2.chm