Site-specific app for Rails docs

Is this your first visit? You may want to subscribe to the feed.

Site-specific app for Rails docs

Unless you’re a Rails genius, you probably need to frequently reference the Rails API docs. And if you haven’t discovered it yet, railsapi.com is awesome.

John Nunemaker suggested that I create a site-specific browser and point it to a local copy of the docs from railsapi.com. I did and have been loving it, so I’m suggesting that you do it too.

Download Fluid (or the comparable app for your platform if you’re not on a Mac). Then download a copy of the docs from railsapi.com and create a new app pointing to that local copy.

Better yet, head over to railslogo.com and grab the Creative Commons licensed logo to use as the icon.

Now my only complaint is that I don’t have docs for Ruby and other gems in this app, but I have a hunch that it won’t be long until that changes.

Code: api, docs, mac, rails May 05, 2009 ● updated May 06, 2009 ● 4 comments

4 comments

http://skitch.com/waloeiii/bqkij/rails-searchable-api-doc

There is support for Ruby and a number of popular gems.

W. Andrew Loe III May 06, 2009 at 12:24 PM
Yeah, I realized that after I posted it. Very cool.

Brandon May 06, 2009 at 12:59 PM
Priit Haamer converted the Rails API docs to OSX’s dictionary format. You may want to check that out if you’re on OSX.

Jonathan Roes May 07, 2009 at 08:03 AM
You might also want to check out RDoctor, which provides access to rdocs for all of your locally installed gems through a browser-like interface. Details are at http://www.idolhands.com/ruby-on-rails/browse-rdocs-in-style-with-rdoctor/

Corey Ehmke June 01, 2009 at 05:04 PM

opensoul.org