An example of a well-documented Rails project and / or best practice

Question

I would like to see an example of a well-documented Ruby on Rails application or for documenting Rails projects .

I'm also curious how to use the Rails documentation tools for developers.

Does anyone have a link to a well-documented Rails project on GitHub?

Answer 1

Rails provides many rake tasks to create complete Rdoc documentation for a project. You can view them using

rake -T doc 

The main task

 rake doc:app 

This requires your codebase to display meaningful comments and usage information.