The API documentation is an in-depth, component by component, look at Rails.

A complete reference to every class, module, and method in the Rails framework.

We'll pay you!
There are currently 2 authors paid by the Caboose Documentation Drive to work on the API documentation, but the more the merrier!

It only takes one, full-time day a week. If you're skilled with the English language and technical writing and want to get paid to use those skills, then please send an e-mail describing yourself, your experience (with writing and with Rails), and, if possible, some writing samples!

You can view the patched version here.

A lot of work has been put into expanding and enhancing the API documentation for Rails.
Click the above link to check out what's been done.

Download the mega patch here.

If you've checked Rails out of Subversion, you can download a big patch that encompasses
all of the documentation patches from the above link.

Visit the project tracker here.

Go to the project tracker on Lighthouse to see what's being worked on, file tickets, and
view the patches individually.

How can I contribute?

There are a few options for you to contribute. First, you can edit the current version and file tickets. Find a grammar snafu? File a ticket! An example need clarification or debugging? File a ticket! Editing the documentation will help iron out the problems more easily to provide better and more accurate documentation. Visit the project tracker here to file tickets or view others' tickets.

Secondly, you can submit patches to the Rails Trac. Getting a patch accepted there will eventually get it worked back into the patched version. Anything to get more documentation into the core is a Good Thing™!

Lastly, you can submit patches back to the project. Find an error in the mega patch? Send us a patch for it and we'll fix it. This is the most direct way you can help in the work that's going on in the API documentation. Just create a ticket with a patch and we'll get to work on it!