RailsBrain logo

Javascript enhanced Rails API docs.

Posted: March 24, 2009

Rails 2.3.2 Posted!

Not much news to report except that a new version has been posted. I am hoping to get back to my work on the new RailsBrain interface now that some of my larger projects are off my plate (and I'm on hiatus from school). I have set a goal of having it done by RailsConf this year! Updates to follow on the railsbrain twitter account.

ps. sorry for the delay in getting this up... automation is definitely going to part of the version two.

Happy coding!

Posted: December 10, 2008

Railsbrain on Twitter and Rails 2.2.2 Posted!

You can now follow the adventures of RailsBrain on twitter!

Okay, it's a bit of what you might call a "Mechanical Turk" since the tweets are generated by me (at least for now). The outbound tweets will be mostly about postings of new versions of the API and issues with system. There also might be some chatter about the new engine thats in the works. Hopefully a Beta system will be finished early Spring of '09.

Oh, and you can tweet @railsbrain with questions or issues. I'll do my best to answer on behalf of the machine. =)

If you are interested more boring things than the Rails API my personal feed is http://twitter.com/breakpointer .


Posted: November 4, 2008

Rails 2.1.2 and Rails 2.0.5 Posted!

Many apologies for the delay in getting these versions up. There is really no excuse (except I have been ridiculously busy). Especially since it is now so simple to install and use the ajax-rdoc template using the rake script we include.

These latest versions also have a new (somewhat hidden) feature. The search box now tries to do a "best guess" match for the string you type. It works similar to QuickSliver. You'll only see this new feature work if you type in a method/class/file name that doesn't have an exact match. I'm not 100% sold that this is a good enhancement to the ajax-rdoc template but it is a step in the right direction. If you have any issues please let me know.

Posted: June 12, 2008

Rails 2.1.0

Some fresh rails! A new version of Rails is out so the API is now up on the site. I am in the process of working on a more automated system for this so that once a new version is released it will automatically get built and uploaded to the site. Also, look for a GitHub service integration in the near future and some more features on the rdoc API interface (like search, and comments!).

Oh, I also wanted to share with you some of the other frameworks using the RailsBrain template.
1) Streamlined Framework - A very cool project. Think rails scaffolding on steroids times 1000!
2) Merb - The framework that needs no introduction. Check out the cool css they added to the docs! Sweet!
3) <Your project here?>

Anyway, the point is... you can download and use the RailsBrain template for your project too! It is super easy. Now if only the Rails core team would respond to my requests to make the RailsBrain template the default format on api.rubyonrails.com!. Come on... FRAMES? Really!?

The source is up on http://github.com/breakpointer/ajax-rdoc/

Also, I would like to thank my sponsors again for the hosting.

Posted: May 28, 2008

At RailsConf2008!

RailsConf 2008 is a blast!
GitHub rocks!
Clone away! http://github.com/breakpointer/ajax-rdoc/

Posted: January 18, 2008

New Rails version + JS fixes

FINALLY got Rails 2.0.2 up! And, thanks to Rick DeNatale (http://talklikeaduck.denhaven2.com/) the JS code has been enhanced to support non-standard search characters! W00t!

Posted: December 20, 2007

Hola new hosting server!

Well, it has been a busy few months. Lots of things going on, launched a couple websites, got a new job, moved to a new city (Chicago, w00t!)...etc...etc... Sadly there was not much time left for me to work on the *brain.com sites.
BUT We've got a new hosting server! Yup, thanks to the great guy(s) over at errfree.com railsbrain.com and rubybrain.com now have a new home. These guys are consummate rails professionals who really know their stuff. Their great commentary on all things ruby can be found on their blog errtheblog.com. Please check it out, it's a great read.

I should also mention that with this new hosting server we'll be better equipped to improve the site by offering more up-to-date rails docs and better features (be on the look out for full documentation search. I'm working on it...)

I would also like to thank two people who recently made a donation to the hosting fund...
Scott Woods
Syed Rizvi

Thanks a bunch!

Posted: October 16, 2007

New version of Rails

Yup, I finally got around to posting the latest version of Rails... number 1.2.4. While this is pretty cool n'all I'm holding out updating my apps until they drop the big two-DOT-oh on us.

So, a few "Thank You"'s are in order to the excellent people who have made donations to the RailsBrain.com hosting fund:
Sudara (http://sudara.modernthings.net)
Jack Danger (http://6brand.com)
Jeff Fox
All have very generously contributed to the railsbrain project. Thanks people!

EDGE RAILS!!! Okay, so I'm very close to getting this up and running on a nightly basis. BUT I have been having some problems... It's kind of funny, for all the sweet talking I did about how awesome MediaTemple is I've run into a few strange problems. SSH access to my account has been very flakey. Sometimes I can get in... sometimes not... I haven't been able to figure out what type of voodoo I need to perform to get this to work consistently. But I can assure you I have submitted a ticket. Let's see how long it takes for them to get back to me...

In the mean time I have a static (oh so very close to edge) version of rails for those of you who can't wait. I will do my best to upload new versions of this nighty but I make no promises. I'll will let you all know when EDGE documentation is fully autonomous.

Posted: September 26, 2007

New hosting company

RailsBrain.com, RubyBrain.com, and the soon to be launched GemsBrain.com are now settled in their new home on a MediaTemple GridServer. I must say that things are pretty nice over here at MediaTemple. Setup was a easy, the site is teh snappy, and I've got lots of flexibility to do as I please (even install my own local Gems!).

Also, with this new hosting company comes new hosting bills. The google ads are not generating enough to cover the hosting costs so I've now added a donate button to the site. If you'd like to chip in a couple [insert local currency here] that would be most excellent! If not, no big deal... Thanks in advance for your contributions.

Oh and there is just one more thing... (lol, Steve Jobs)

Edge Rails
I received a request to add documentation for edge rails to the site... Seems like a good idea to me so I will be adding it post-haste. It will be setup to regenerate documentation every night so you'll have fresh piping hot edge docs waiting for you in the morning. =)
It should be up by the end of the week.

Posted: July 31, 2007

Lots of new developments...

RailsBrain is available for download! For those of you who work off-line from time-2-time you can now download the entire documentation to your computer. No special requirements, nothing to install, just point your web browser at index.html after you unzip the package and you're ready to go.

The source code is available on rubyforge! The template that I use to generate the javascript enhanced rdocs on this site is available on rubyforge.org (the url is http://rubyforge.org/projects/jaxdoc/) I encourage you all to check it out, download the template (instructions are in the README), and start generating railsbrain-like interfaces for ruby code you use frequently. NOTE: I haven't done a whole lot of testing on this code... it *should* work... but I can't make any claims. Let me know if you run into any problems and I'll do my best to address them. OR since it's now up on rubyforge maybe some of you would like to help out... *cough* hint hint.

There is now advertising on the site... which I was reluctant to add. Unfortunately, hosting bills don't pay themselves (but they might if you take notice of the new sponsorship!)

Feedback is always welcome... my email is blchamberlain+rb@gmail.com

P.S. The old version of the site (for rails-1.2.2) is still up if these new versions are totally broken for you.
The url is http://www.railsbrain.com/old/index.html

P.P.S. Check out the RubyBrain.com. View the Ruby api with RailsBrain ease!

Posted: May 25, 2007

Yikes, has it really been that long?

Well, I've been busying myself with this rails api project for quite a while now... it's about time for a new version. Unfortunately, I have been swamped with work so that has slowed development a bit (and by a bit I mean, a lot). However, there is a new version available for *testing* (actually several new versions) complete with new features and some bugs (which I will sort out ASAP).

So what is in this new version you ask?

Well... I've tackled a few of the features on my previous list but not all. For this release there will be BROWSER BACK BUTTON SUPPORT!!! yay! And with it the ability to bookmark, email, and msg to your friends the urls for the rails methods you favor the most.

Also included are some bug fixes, and small tweaks to css, javascript, and the like. You'll also notice there is a new browser bar that shows you the context for the doc page you are currently viewing.

Features that are still in the works are... text wide searching... improved styling... and a few other things which will need quite a bit of work. I am hoping I can find the time.

The soon-to-be released versions are available now at the following url's:

I should have the final versions of these sites up by next week.


P.S. – Like I said before... feel free to email me at blchamberlain+rb@gmail.com Thanks!

Posted: May 7, 2007


Thanks for checking out my rails api project. I hope you find my interface for navigating the Ruby on Rails API easy to use.

It's a bit messy in here (code wise). I wasn't expecting so many visitors so soon. It feels a bit like being the host of a party where the guests show up while you're still in the kitchen making the hors d'oeuvres. I mean, take this page for example, clearly it was thrown together last minute. =)

That being said, I am in full cranking-out-the-code mode and busy polishing up the next version of the site. I am really excited you all have found this useful. Keep in mind that this is still in development and there are plenty of more features to come.
Here is what's next...

  • Other versions of rails — This is for those of you (myself included) who are still maintaining sites that are on older versions of rails. The horror!
  • Browser back button support!!! (and with that should come bookmarkability)
  • Cleaner documentation content — That old-skool rdoc css has to go!
  • Bug fixes, some UI tweaks, better browser support, cleaner (and faster) js code
  • oh, and documentation wide text search

Stay tuned!


P.S. – Until I have a proper method for collecting bugs and feature requests... feel free to email me at blchamberlain+rb@gmail.com Thanks!