# Ruby and Rails Doc

**URL:** <https://www.ruby-forum.com/t/ruby-and-rails-doc/129746>\
**Category:** Rails\
**Created:** [February 21, 2008, 9:05am UTC](https://www.ruby-forum.com/t/ruby-and-rails-doc/129746 "2008-02-21T09:05:12Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![bcurtu](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/a88e4f/32.png) [@bcurtu](https://www.ruby-forum.com/u/bcurtu)\
**Post date:** [February 21, 2008, 9:05am UTC](https://www.ruby-forum.com/t/ruby-and-rails-doc/129746/1 "2008-02-21T09:05:12Z")

</div>

Hi there,

I come from java world, and used to javadoc APIs documentation. When I  
try to read the Ruby doc or the Rails doc I feel uncomfortable.

How is it supposed the R\*doc be used? I mean there are 3 sections on  
the left side menu, what do they contain?

Is there any kind of guide to get started with Ruby and Rails  
documentation?

Cheers

---

<div class="post-metadata">

**Author:** ![bcurtu](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/a88e4f/32.png) [@bcurtu](https://www.ruby-forum.com/u/bcurtu)\
**Post date:** [February 21, 2008, 10:26am UTC](https://www.ruby-forum.com/t/ruby-and-rails-doc/129746/2 "2008-02-21T10:26:23Z")

</div>

the three parts on left side:

1. all the files that come with rails  
not that important in the beginning

2. the classes  
three most important: ActionController, ActiveRecord, ActiveView  
and their modules like ActiveRecord::Base, ActiveRecord::Callbacks…

3. methods of classes  
that’s where you search for keywords and functionality  
if you don’t know where to find them

eg: you want to know something about the ActiveRecord callback  
before\_save, you search in the methods list for it  
later on you’ll know, that it’s a callback and directly use  
the class list and jump to ActiveRecord:Callbacks

---

<div class="post-metadata">

**Author:** ![bcurtu](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/a88e4f/32.png) [@bcurtu](https://www.ruby-forum.com/u/bcurtu)\
**Post date:** [February 21, 2008, 12:10pm UTC](https://www.ruby-forum.com/t/ruby-and-rails-doc/129746/3 "2008-02-21T12:10:03Z")

</div>

Thanks, that’s usefull!

On Feb 21, 10:26 am, Thorsten M. \<rails-mailing-l…@andreas-

---

<div class="post-metadata">

**Author:** ![bcurtu](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/a88e4f/32.png) [@bcurtu](https://www.ruby-forum.com/u/bcurtu)\
**Post date:** [February 21, 2008, 9:23pm UTC](https://www.ruby-forum.com/t/ruby-and-rails-doc/129746/4 "2008-02-21T21:23:17Z")

</div>

bcurtu wrote:

> Thanks, that’s usefull!
> 
> On Feb 21, 10:26 am, Thorsten M. \<rails-mailing-l…@andreas-

I would suggest [http://rails.noobkit.com/](http://rails.noobkit.com/) or [http://railsbrain.com](http://railsbrain.com).