Multiple Sets of Documentation?

What the heck is going on with all the documentation projects? As far
as I
can tell, is the most complete, but very hard to
navigate. I just found, which seems to be a different
front-end for it.
What do you all use? Is there one that is currently “the best?”
and I hope I don’t cause a flame war :slight_smile:

Here are some links I can’t figure out
does this relate to the above project?

I run railsmanual, which is basically just a dump of the rdocs in a
searchable fashion using Rannotate. I use it in combination with

I still haven’t seen a doc site that works perfectly yet… still
Haven’t had the time I wished I had to make railsmanual into the site I
it can be. Maybe one day someone will sponsor me to :slight_smile:


On Wed, Jul 16, 2008 at 11:31 AM, Sean C. Hess [email protected]

I build local rdoc for each project so I have the docs that coorespond
to the Rails that is being used (yes, burned by newer stuff that just
doesn’t seem to work when you try it in an old project :wink:

I use the same ajax format as by making these changes
to vendor/rails/railties/lib/tasks/documentation.rake

@@ -4,6 +4,7 @@
rdoc.rdoc_dir = ‘doc/app’
rdoc.title = “Rails Application Documentation”
rdoc.options << ‘–line-numbers’ << ‘–inline-source’

  • rdoc.options << ‘–fmt=ajax’ << ‘-T ajax’
    @@ -15,6 +16,7 @@
    rdoc.template = “#{ENV[‘template’]}.rb” if ENV[‘template’]
    rdoc.title = “Rails Framework Documentation”
    rdoc.options << ‘–line-numbers’ << ‘–inline-source’
  • rdoc.options << ‘–fmt=ajax’ << ‘-T ajax’
    @@ -64,7 +66,8 @@
    options << “-o doc/plugins/#{plugin}”
    options << “–title ‘#{plugin.titlecase} Plugin
    options << ‘–line-numbers’ << ‘–inline-source’
  •    options << '-T html'
  •    # options << '-T html'
  •    options << '-T ajax' << '--fmt=ajax'
        if File.exists?("#{plugin_base}/README")

Now if I could only remember where that ‘ajax’ format and template


On Jul 16, 2008, at 2:47 PM, Nathaniel B. wrote:

Here are some links I can’t figure out

Rob B.
[email protected]
+1 513-295-4739
Skype: rob.biedenharn