I'm currently preparing some learning materials for a course I'm teaching on Ruby and Rails and I've come across a couple issue with the published RDocs.
Searching for "ActiveRecord Validations" returns the following two as the top results:
Firstly, the docs at ar.rubyonrails.org are several years old! These should either be updated, or removed/redirected as they consistently feature in search results for Rails classes/modules.
Also, are there any plans to move away from frames-based RDocs at api.rubyonrails.org? Last I checked, the 1990s were a long time ago! It's a very unfriendly experience for a new Rails developer searching for "ActiveRecord::Validations" to end up at an orphaned page outside of the frames.
El 1 Aug 2011, a les 17:40, Tekin Suleyman <tekin@tekin.co.uk> va escriure:
I'm currently preparing some learning materials for a course I'm teaching on Ruby and Rails and I've come across a couple issue with the published RDocs.
Searching for "ActiveRecord Validations" returns the following two as the top results:
Yes, those were officially deprecated with Rails 3.0 and no longer generated. Thanks for pointing that out, I'll try to get the vhosts offline or with redirections.
Firstly, the docs at ar.rubyonrails.org are several years old! These should either be updated, or removed/redirected as they consistently feature in search results for Rails classes/modules.
Also, are there any plans to move away from frames-based RDocs at api.rubyonrails.org? Last I checked, the 1990s were a long time ago! It's a very unfriendly experience for a new Rails developer searching for "ActiveRecord::Validations" to end up at an orphaned page outside of the frames.
Yes, there are concrete plans for this that are being worked out these days. If everything goes well, the API for 3.1 will improve that experience.
Great stuff. The Rails Guides have done an amazing job of improving the available documentation for Rails, good to hear that the Rdocs are getting some love too - they are equally important, especially for those wanting to delve a little deeper into the mechanics of Rails but aren't comfortable delving into the source.
