Ruby on Rails Manual

by Nathaniel S. H. Brown

When it comes to building a Rails application, the one site I constantly reference when finding out attributes for methods such as create_table or finding out what CallBacks I can use to hook in additional functionality, Rails Manual has been invaluable.

Just recently I updated the site with the latest version of Rannotate, which has a ton of new features and functionality enhancement by Conor Hunt.

Most importantly is the ability for you to be able to have multiple versions of a library, such as the first major version of Rails 1.0.0 or the latest version being 1.1.2. You can see all the methods within each version, as well as add comments to each of the methods within each.

The idea is to replicate the same usefulness of the PHP documentation, which I am personally sure is one of the main reasons why PHP has become so widely adopted.

It is important to note that although Rannotate is used on RailsManual exclusively for Ruby on Rails functionality, the library is excellent for documenting all types of Ruby and Rails applications, and could very well be hosted internally for your own API.

UPDATE: Like it too? Digg it!

3 Comments

Vivek
2006-05-30 07:14:15
Not sure if its known, but class file links are broken eg. src/rails-1.1.2/railties/lib/dispatcher.rb


Nathaniel
2006-05-31 06:14:03
Thanks for the heads up Vivek. I had to update the Rannotate routes so it could work with Apache's mod_security. Was fixed by removing the ":name" portion of the route for /file/, so that name was passed as a parameter and didn't get confused with the slashes from the path of the file itself.


#map.connect 'file/:name/:method/:version', :controller => 'doc', :action => 'files', :method => nil, :version => nil


map.connect 'file/:method/:version', :controller => 'doc', :action => 'files', :method => nil, :version => nil

Hisham ElHifnawi
2007-08-23 13:54:48
Hi,


I wanted to know the script file that generates the rails skeleton. so I knew that the following two file do! so I was confused


"You might want to check the source for the console script that generates a
skeleton:
http://dev.rubyonrails.org/browser/tags/rel_1-2-3/railties/bin/rails "
and I found also
http://developers.joyent.com/browser/windows/VM/ruby/bin/rails?rev=22


I was told That is the same script copied to another location. You can study any of these 2 scripts to find out how to invoke the app generator.


so 1st I am confused coz the two scripts are different in code and how would I invoke app_generator, by running other ruby scripts or writing my own ruby script then running it?
my emails is hisham86@aucegypt.edu