Combined docs Ruby and Rails in one

Ruby

Rails


Single docs only Ruby or Rails

Ruby

Rails


About

A essential requirement for software developers to be able to work efficiently and "get into the zone" is quick and convenient access to documentation. I always felt Ruby and Ruby projects (and specifically Rails) were lacking in that regard. While many projects are very well documented, the visualization and access to those docs are often less than ideal.

By far the best option I found are docs based on the sdoc format. They are clearly arranged, searchable, and very responsive. On top of that, the docs for multiple projects can be combined, so that one can for example search the Ruby and Rails docs simultaneously - a huge advantage when a framework and a language are so intertwined.

The problem is that developers often work on multiple projects simultaneously, and each one may be using a different Ruby and a different Rails version. Combined docs with those exact versions are a huge advantage in that case.

A big thank-you to Rob Cameron, who developed the first version of this site!

For feedback, comments, feature requests etc. please use the comments below or get in touch on Twitter.


Built by Kraut Computing with for the Ruby community.
The source code is available under the MIT license on Github and bug reports, feature requests, and contributions are welcome!

Thanks to Digitalocean logo and Maxcdn logo
for generously sponsoring hosting and CDN usage, respectively.


comments powered by Disqus