Multiple Sets of Documentation?

rubyonrails-talk
1

What the heck is going on with all the documentation projects? As far as I can tell, api.rubyonrails.com is the most complete, but very hard to navigate. I just found railsbrain.com, which seems to be a different front-end for it.

What do you all use? Is there one that is currently “the best?” Thanks, and I hope I don’t cause a flame war :slight_smile:

Here are some links I can’t figure out

http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch - does this relate to the above project?

http://railsmanual.com/

http://railsapi.org/

2

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

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

Nathaniel.

3

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 railsbrain.com 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’

rdoc.rdoc_files.include(‘doc/README_FOR_APP’)

rdoc.rdoc_files.include(‘app/**/*.rb’)

rdoc.rdoc_files.include(‘lib/**/*.rb’)

@@ -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’

rdoc.rdoc_files.include(‘README’)

rdoc.rdoc_files.include(‘vendor/rails/railties/CHANGELOG’)

rdoc.rdoc_files.include(‘vendor/rails/railties/MIT-LICENSE’)

@@ -64,7 +66,8 @@

options << “-o doc/plugins/#{plugin}”

options << “–title ‘#{plugin.titlecase} Plugin Documentation’”

options << ‘–line-numbers’ << ‘–inline-source’

  •    options << '-T html'

  •    # options << '-T html'

  •    options << '-T ajax' << '--fmt=ajax'

files.include(“#{plugin_base}/lib/**/*.rb”)

if File.exists?(“#{plugin_base}/README”)

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

-Rob