Writing Rails project documentation

Question

Hi to all. Give me an example, that's you can describe as "well documented project on Rails", or "best practices of making documentation for Rails project" (with link to github, or other same site, if it possible).

And, what tools do you prefer to use for writing documentation of your project?

Answer 1

Rails provides a bunch of rake tasks to generate a full Rdoc documentation for the project. You can view them with

rake -T doc

The main task is

rake doc:app

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