Read The Nice Manual
In the happy world of Ruby, we don't RTFM, we RTNM!
A few months ago, we made an RDoc theme. Its goal was to improve the layout, the navigation, and the reading comfort. We were using it to generate the Ruby documentation.
We decided to take it one step further by generating the documentation for a select group of Ruby gems. So here we are with RubyRubyRubyRuby.dev.
Even if RDoc itself improved nicely in the previous months, we believe you will enjoy reading documentation with a common layout for various gems. So far, we noticed a good effect on us. We are getting used to clicking on random classes and reading their methods to learn new things. We hope you’ll find that too.
For now, adding a new gem to RubyRubyRubyRuby.dev is a manual process because, most of the time, it requires some adjustments. Some of those need to be done into the theme or the generating script. However, sometimes, there is no other choice but to suggest them in the repository for the gem. For example, one common problem is misusing heading ranks.
Documentation for many gems is quite often limited to the README only. We plead guilty as we were doing this with our own gems. Although it’s sufficient for the simplest cases, it would be better if every gem had its public methods properly documented. We updated the ActiveHascash documentation to see what it takes: not that much. Hopefully, having a nice theme will encourage gems authors to write better documentation.
If you’d like to add your favorite gems or suggest some improvements, you’re welcome to send us pull requests.
