[ANN] RailsManual.org (the PHP like searchable doc site) jus

Wanted to let you guys know that railsmanual.org just got updated with
the documentation for the latest versions of Rails: 1.2.0 and 1.2.1.

http://railsmanual.org

Tip: If you are a firefox user, you can add the bookmark under “Quick
Searches” (Command-B to see the side-bar, and it’s at the bottom), and
map it to a keyword, or letter such as “r”. This way you can load up a
new tab, Command-T, and type “r link_to” in the location bar and do an
instant search on the site. Here is the URL you can put “Location:”
field when creating the bookmark.

http://www.railsmanual.org/doc/search?name=%s

Just came across this plugin written by Gregoire Lejeune for Firefox as
well.

http://mycroft.mozdev.org/download.html?name=railsmanual.org&sherlock=yes&opensearch=&submitform=Search

nice work! handy to have all the versions available in one spot.

ed

http://www.rubyinside.com/search/

On 1/27/07, Jeff B. [email protected] wrote:

On 1/23/07, Nathaniel B. [email protected] wrote:

Limited seating, register now!


Ed Hickey
Developer
Litmus Media
816-533-0409
[email protected]
A Member of Think Partnership, Inc
www.ThinkPartnership.com
Amex ticker symbol: THK

On 1/24/07, Nathaniel B. [email protected] wrote:

the documentation for the latest versions of Rails: 1.2.0 and 1.2.1.

http://railsmanual.org

Railsmanual and the firefox plugin are great! Thanks for all who made
this
possible!!

Does anyone know if there a similar firefox plugin for the Ruby
language, so
you can add it as a search option?


Jeff B., MasterView core team
Inspired Horizons Ruby on Rails Training and Consultancy
Next Ruby on Rails plus JRuby workshop Feb 22-24 St. Louis, MO
http://inspiredhorizons.com/training/rails/index.html
Limited seating, register now!

On 1/27/07, Ed Hickey [email protected] wrote:

http://www.rubyinside.com/search/

Thanks!! Now I am happy! :slight_smile:


Jeff B., MasterView core team
Inspired Horizons Ruby on Rails Training and Consultancy
Next Ruby on Rails plus JRuby workshop Feb 22-24 St. Louis, MO
http://inspiredhorizons.com/training/rails/index.html
Limited seating, register now!

fyi, i get a NoMethod error when clicking on the ‘+ (SummablePayment)’
link in the 1.2.1 manual on your site.

http://railsmanual.org/class/SummablePayment/+/1.2.1

Nathaniel B. wrote:

Wanted to let you guys know that railsmanual.org just got updated with
the documentation for the latest versions of Rails: 1.2.0 and 1.2.1.

http://railsmanual.org

Tip: If you are a firefox user, you can add the bookmark under “Quick
Searches” (Command-B to see the side-bar, and it’s at the bottom), and
map it to a keyword, or letter such as “r”. This way you can load up a
new tab, Command-T, and type “r link_to” in the location bar and do an
instant search on the site. Here is the URL you can put “Location:”
field when creating the bookmark.

http://www.railsmanual.org/doc/search?name=%s

Just to bad it’s very slow. I think railsmanual is a step in the right
direction in otherwise poor manuals for rails in terms of understanding
and learning (for us newbies). Any plan to improve server speed? And any
plan to improve understanding? I would like more exemplification and
comments and get it more like the php-manual, which is really good.

What part of the site is slow?

I noticed that the single pages listing all the methods are, but that
is somewhat to be expected (due to implementation) as it lists the
thousands of methods within the entire framework.

On 1/27/07, Pål Bergström [email protected] wrote:

new tab, Command-T, and type “r link_to” in the location bar and do an


Posted via http://www.ruby-forum.com/.


Nathaniel Steven Henry Brown

Toll Free: 1-877-446-4647
Vancouver: 604-724-6624

This is really nice! Is there an easy way to restrict searches to a
particular version of the API, say 1.1.6?

Wes

Hmm, it does seem slow, are you using rails page caching at all? Or gzip
compression? The original rails docs site (api.rubyonrails.org) is quite
fast, despite loading thousands of methods. I know it’s in frames, but
the
frames containing the classes & methods load almost instantly. Of
course,
all pages are static HTML and not rendered by ruby in real-time.

Also, looked at the size of some of your pages compared to sizes on
api.rubyonrails.org:

Files:

Classes:

Methods:

And I noticed you are including a lot of methods not included on
api.rubyonrails.org. For instance, railsmanual.org lists 142 methods
named
“setup”. Most of them are setup methods for various Test::Unit suites in
rails. api.rubyonrails.org doesn’t list these. Probably useful for a
rails
core developer, but not for a typical user of rails docs. Is
railsmanual.orgignoring the "nodoc"s?

I write all of this because I do want railsmanual.org to succeed and be
a
useful resource.


Scott B.
Electro Interactive, Inc.
Office: 813-333-5508
http://www.ElectroInteractive.com

Nathaniel B. wrote:

What part of the site is slow?

Every part. Sometimes ok like today, but often I find it slow, mostly
lisiting (at the same time I can understand why).

The only problem for me as a novice is that I have to know what to look
for. Would be good if it was divided into areas – like php. Then it
wouldn’t be so slow as you come to a first level that doesn’t list
everything at once.

Another developer created something similar for ColdFusion which uses
Adobe’s Livedocs. I like how you can search for functions or tags and
AJAX lists all of the available tags or functions while you type. It
is really fast and useful, and could be a used as an example for
RailsManual.org (for files, classes and methods).

See http://cfquickdocs.com

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs