# Searchable Rails API Docs?

**URL:** <https://www.ruby-forum.com/t/searchable-rails-api-docs/119197>\
**Category:** Rails\
**Created:** [November 4, 2007, 9:02pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197 "2007-11-04T21:02:16Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 4, 2007, 9:02pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/1 "2007-11-04T21:02:16Z")

</div>

Is there a version of the Rails API anywhere that is searchable?

The RDoc dump at [api.rubyonrails.org](http://api.rubyonrails.org) is spiffy and all, but it can  
very difficult to use productively under many scenarios IMO.

– gw

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 4, 2007, 9:19pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/2 "2007-11-04T21:19:21Z")

</div>

[gotapi.com](http://gotapi.com), [railsmanual.org](http://railsmanual.org), [http://caboo.se/doc.html](http://caboo.se/doc.html)

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 4, 2007, 9:29pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/3 "2007-11-04T21:29:18Z")

</div>

Try [http://www.railsapi.org](http://www.railsapi.org). There is even a place to add comments.

Yes, [api.rubyonrails.org](http://api.rubyonrails.org) is not real documentation. It isn’t even API  
documentation, it’s just Rdoc. Sometimes it gives enough information  
to write code, sometimes not.

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 4, 2007, 9:35pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/4 "2007-11-04T21:35:44Z")

</div>

On Nov 4, 2007, at 12:01 PM, Greg W. wrote:

> Is there a version of the Rails API anywhere that is searchable?

OK, thanks for the URLs. None are helping with my objective. They  
don’t appear to search the actual contents of all those RDocs.

– gw

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 4, 2007, 9:21pm UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/5 "2007-11-04T21:21:42Z")

</div>

I’ve always liked [http://www.railsbrain.com](http://www.railsbrain.com)

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 5, 2007, 12:14am UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/6 "2007-11-05T00:14:53Z")

</div>

On 04 Nov 2007, at 21:35, Greg W. wrote:

> > Is there a version of the Rails API anywhere that is searchable?
> 
> OK, thanks for the URLs. None are helping with my objective. They  
> don’t appear to search the actual contents of all those RDocs.

Get the chm version: [http://delynnberry.com/projects/rails-chm-](http://delynnberry.com/projects/rails-chm-)  
documentation

Then just open it on Winblows or use Chamonix on Mac (or a CHM viewer  
on Linux). Works extremely well for fulltext searches.

Best regards

Peter De Berdt

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 5, 2007, 3:04am UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/7 "2007-11-05T03:04:57Z")

</div>

On Nov 4, 2007, at 3:13 PM, Peter De Berdt wrote:

> Then just open it on Winblows or use Chamonix on Mac (or a CHM  
> viewer on Linux). Works extremely well for fulltext searches.

Yeah, that’s an improvement. Thanks.

– gw

---

<div class="post-metadata">

**Author:** ![S-gw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/ed655f/32.png) [@S-gw](https://www.ruby-forum.com/u/S-gw)\
**Post date:** [November 5, 2007, 4:01am UTC](https://www.ruby-forum.com/t/searchable-rails-api-docs/119197/8 "2007-11-05T04:01:40Z")

</div>

for searchable docs, I like this alot

[http://labs.parkerfox.co.uk/ruby.search/](http://labs.parkerfox.co.uk/ruby.search/)

–linoj