Rails Guides Gets a Facelift

Posted by Mike Gunderloy February 04, 2009 @ 01:05 AM

There’s a brand new version of Rails coming, as you already know. What better time for a new version of some of the Rails documentation? So the Rails Guides team is pleased to announce a refresh of the Ruby on Rails Guides site, just in time for the Rails 2.3 release.

The most obvious change you’ll see is a new look, thanks to some awesome design work from Jason Zimdars. But the visual refresh isn’t all that’s going on here. We’ve also been working to update the Guides for Rails 2.3, as well as to add new guides to the list.

And there’s good news if you want to get involved too. Behind the scenes, Tore and Pratik switched our markup engine from AsciiDoc to Textile. This makes the Guides easier to write and edit and easier to build into a Rails project. If you’ve got some spare time to help out, join us in the #docrails room on irc.freenode.net, and help make the Rails Guides into a great resource in time for the 2.3 release.

Posted in Documentation | 11 comments

Comments

  1. Roland on 04 Feb 02:14:

    Very cool!

    By the way: any plans to keep different versions of the guides online e.g. when someone still has to use rails 2.2.x for whatever reason?

  2. Pratik on 04 Feb 02:22:

    Roland, not at the moment. You can just ‘rake doc:guides’ from inside your application and the appropriate guides will get generated under doc/guides.

  3. Web Reservoir on 04 Feb 03:15:

    Hello,

    Can i use this new Rails 2.3 guides as a first stepping stone that proceeds towards Rails 3.0..?

    I mean, will this guide progress further as Rails 2.4, 2.5, 2.9 and finally 3.0 or will it be totally different than the current scenario…?

    Sorry for my newbie questions

  4. Mike Gunderloy on 04 Feb 10:28:

    As Rails progresses, the Guides will be revised to keep up with the current version. We don’t have any plans (yet) to cover conversion/upgrading issues, though it’s likely that will come along in the 3.0 timeframe.

  5. Jay on 04 Feb 12:18:

    Awesome job!

  6. dwillett on 04 Feb 14:47:

    Nice, digging the icons.

    The tt tags overlap each other in lists and on consecutive lines. Maybe font-size .8em ?

  7. Pratik on 04 Feb 15:05:

    dwillett : Yeah I think that’s an issue in Firefox ( works fine in Safari ). We do have some more minor CSS issues pending. All in good time :)

  8. Daniel Lopes on 04 Feb 16:42:

    Hum… much better, but I think we will have some problem to convert all job we already done in PT-BR translation.

    But is a good cause. Documentation is really important step to improve Rails.

  9. Bob Martens on 04 Feb 22:21:

    Wow, nice work. I look forward to the ongoing evolution of the Guides.

  10. Dave Porter on 04 Feb 23:37:

    Great Job guys, huge improvement…

  11. case on 05 Feb 09:56:

    nice style…

    but the several diffrent styles and domains for diffrent site parts are not very nice. isn’t it possible to migrate all micro sites to one big site? this will improve the usability…