Good Looking Searchable Rails API Docs
"Better" Rails documentation efforts aren't anything new but Vladimir Kolesnikov's attempt titled "Rails Searchable API Doc" is notable for its simplicity and smart presentation. He hasn't changed the usual IRB layout except to add a rather Mac-looking search frame to the left hand side in replacement of the usual file and class lists.
By default, the left hand frame shows an expandable tree of the various components and classes in Rails, but by typing into the search box at the top, you get quick fire links to the documentation you need. All very fast and good looking too.
You can browse the documentation online or download a 2 megabyte ZIP file to keep a local copy. Also of note is Vladimar's rather illustrative site promoting the tool - I'd love to see more like this.
March 17th, 2009 at 5:02 pm
there is another one I love to use is http://apidock.com/rails/
March 17th, 2009 at 5:47 pm
Yea, I really like ApiDock, especially with the TextMate integration:
http://blog.nodeta.fi/2009/02/23/apidock-in-textmate/
But to be fair, this project here is also looking pretty cool!
March 17th, 2009 at 6:25 pm
This acts like http://www.railsbrain.com too.
March 19th, 2009 at 10:02 pm
"this acts like railsbrain"? Can we use it as a template for generating any rdocs? I had a quick look but I couldn't see.