# Rubybrain.com

**URL:** <https://www.ruby-forum.com/t/rubybrain-com/132778>\
**Category:** Ruby\
**Created:** [March 24, 2008, 5:32pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778 "2008-03-24T17:32:54Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 24, 2008, 5:32pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/1 "2008-03-24T17:32:54Z")

</div>

I am really confused by [rubybrain.com](http://rubybrain.com).  
I like the interface much more than the [ruby-doc.org](http://ruby-doc.org) documentation, Ajax  
makes it much more responsive.  
But somehow I could never find what I was searching for and ended up  
looking somewhere else.  
Just some minutes ago I wanted to look up Ruby’s String methods… not  
such an unusual task one might think.  
Searching for the String class led me here:  
[rubybrain.com is For Sale](http://www.rubybrain.com/api/ruby-1.8.6/doc/index.html?a=C00000226&name=String)  
But where are the instance methods?  
The [ruby-doc.org](http://ruby-doc.org) docs have them:  
[class String - RDoc Documentation](http://www.ruby-doc.org/core/classes/String.html)

Someone please tell me what I do wrong (with the optional hint that I am  
stupid)!

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 24, 2008, 6:50pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/2 "2008-03-24T18:50:31Z")

</div>

On Mar 24, 1:32 pm, Zoop Z. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> Someone please tell me what I do wrong (with the optional hint that I am  
> stupid)!

Do not NoobKit [1] also work for you?

I don’t know about these projects, each one implements the search and  
documentation functionality quite differnt.

[1] [http://www.noobkit.com](http://www.noobkit.com)

HTH,

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 24, 2008, 7:27pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/3 "2008-03-24T19:27:34Z")

</div>

Luis L. wrote:

> Do not NoobKit [1] also work for you?

Thanks, Luis, I’m gonna try that!

Anyhow, does anybody else have any idea why [Rubybrain.com](http://Rubybrain.com) does not  
contain instance methods?

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 24, 2008, 7:42pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/4 "2008-03-24T19:42:20Z")

</div>

While noobkit is visually pleasing and I think a step in a right  
direction (hope the official ruby website can incorporate some ideas) I  
think using flash is a bad idea for documentation. (They use flash for  
side-navs last time I checked)

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 25, 2008, 9:05pm UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/5 "2008-03-25T21:05:36Z")

</div>

Interesting.  
Ken, what do you think of [gotapi.com](http://gotapi.com)?  
You have to add the RoR or “Ruby standard packages” API first.

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 26, 2008, 5:40am UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/6 "2008-03-26T05:40:34Z")

</div>

On Tue, 25 Mar 2008 15:05:26 -0500, Zoop Z. wrote:

> Interesting.  
> Ken, what do you think of [gotapi.com](http://gotapi.com)? You have to add the RoR or “Ruby  
> standard packages” API first.

Pretty good. It doesn’t include the ruby core though. Guess I need two  
different sites, plus “gem server” for my gems?? That’s too much  
difficulty.

–Ken

---

<div class="post-metadata">

**Author:** ![zoopzoop](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/z/59ef9b/32.png) [@zoopzoop](https://www.ruby-forum.com/u/zoopzoop)\
**Post date:** [March 25, 2008, 1:11am UTC](https://www.ruby-forum.com/t/rubybrain-com/132778/7 "2008-03-25T01:11:25Z")

</div>

On Mon, 24 Mar 2008 11:32:45 -0500, Zoop Z. wrote:

> I am really confused by [rubybrain.com](http://rubybrain.com). I like the interface much more  
> than the [ruby-doc.org](http://ruby-doc.org) documentation, Ajax makes it much more responsive.  
> But somehow I could never find what I was searching for and ended up  
> looking somewhere else.  
> Just some minutes ago I wanted to look up Ruby’s String methods… not  
> such an unusual task one might think. Searching for the String class led  
> me here:  
> [rubybrain.com is For Sale](http://www.rubybrain.com/api/ruby-1.8.6/doc/index.html)?  
> a=C00000226&name=String  
> But where are the instance methods?  
> The [ruby-doc.org](http://ruby-doc.org) docs have them:  
> [class String - RDoc Documentation](http://www.ruby-doc.org/core/classes/String.html)
> 
> Someone please tell me what I do wrong (with the optional hint that I am  
> stupid)!

[rubybrain.com](http://rubybrain.com) includes only methods from the standard library (http://  
[RDoc Documentation](http://www.ruby-doc.org/stdlib/)) which you get by require’ing various files  
outside of the core itself. It does not include the core methods at all.  
It also doesn’t tell you which files you need to include to get specific  
instance methods (though you can see this by clicking “show source”).

[ruby-doc.org](http://ruby-doc.org) suffers from the opposite problem. [RDoc Documentation](http://www.ruby-doc.org/stdlib)  
is really nice, letting you know exactly what you need to include, but  
[RDoc Documentation](http://www.ruby-doc.org/core) is miserably broken, mixing the core methods and  
the stdlib methods with no way of telling which is which.

[noobkit.com](http://noobkit.com) gets it right for the core documentation, but works like  
[rubybrain.com](http://rubybrain.com) for the stdlib documentation.

I feel these all miss the features that are truly necessary to use the  
documentation. The underlying schema should be as follows:

±------------±----------------------------------------+  
| ClassName | |  
| MethodName | (null if we’re talking about a class |  
| | or a module) |  
| FileDefined | (or a special marker for core methods) |  
| DocComment | (the doc comment for this class/method |  
| | in this file) |  
| IsModule | (for class/module definitions only) |  
| SuperClass | (for class definitions only. |  
| | Never store “Object” here, because some |  
| | fancy logic is in order to determine |  
| | whether we’re extending the class or |  
| | defining it for the first time with |  
| | no ancestor.) |  
±------------±----------------------------------------+

One should be able to filter by ClassName, FileDefined, or MethodName  
(and hopefully some predefined groups of files, corresponding to natural  
standard library divisions) including several of these criteria  
simultaneously, and get a single documentation page that lays out all of  
the documentation matching the filter.

Anybody got a rails app that does that?
