Dokumentasi Ruby Gems dan Ruby on Rails

Ada dua buah dokumentasi yang harus sering anda baca selain dokumentasi API RoR resmi, yaitu:

Dokumentasi Gem
Dokumentasi Gem merupakan dokumentasi yang di-generate berdasarkan gem-gem apa saja yang anda install. Untuk membuat dokumentasi gem, ketikkan perintah sebagai berikut.

gem server

Setelah selesai, buka web browser anda dan ketikkan http://localhost:8808 untuk membaca dokumentasi gem yang telah di-generate.

Dokumentasi Aplikasi Ruby on Rails
Dokumentasi ini merupakan dokumentasi yang di-generate berdasarkan aplikasi Ruby on Rails yang dibuat dan plugin yang digunakan, jadi misalkan aplikasi anda memiliki controller products dengan action show, maka otomatis akan dimasukkan ke dalam dokumentasi. Untuk membuat dokumentasi ini, lakukan langkah-langkah berikut.

cd rails-app-anda
rake rails:freeze:gems
rake doc:rails

Hasil perintah di atas akan menghasilkan dokumentasi pada direktori doc/api. untuk membaca dokumentasi, buka dengan web browser berkas doc/api/index.html .