Hello.
Welcome to the Rails Documentation Project.
This site will hopefully become the hub for community participation in documenting Ruby On Rails.
We hope to pull together a set of the API docs, a book, some PDF minidocs, and a set of links to other places you can visit to learn more about Rails.
The API documentation is an in-depth look at the Rails framework, module by module, class by class, method by method. Each component is documented thoroughly, with a large number of examples and use cases. The API documentation is automatically generated from the RDoc documentation attached to the Rails source code, which is constantly being worked on by the community. Visit them here or click here to learn more about them.
We hope to host a selection of minidocs too, which cover a single topic in-depth, such as routing or REST. Though we dont have any available just yet, they will available as PDFs from this page completely for free. These books are written by us, the community (which includes you!), so if you have anything you'd like hosting for others, we'll gladly relieve you of some bandwidth and pimp your work.
Don't forget to join the community also! We have an IRC channel on Freenode at #rails-doc, and a mailing list for general documentation discussions. Visit the Community page to find out about even more options.
You can contribute directly to the project by visiting the page for each (the API documentation, the book, and the minidocs) for instructions, or you can contribute indirectly by starting a blog or submitting tickets for any of the above projects.
We would also appreciate any sort of financial support you could provide. Running this site isn't free, nor is paying for authors or editors to work on improving the documentation. The more funding we have available, the more hands we can get working on the project for more time. We'll have more information about donating to the project available for you soon.
You are! Well, maybe not just you, but if you're here you're part of the community, and that's who create the content of this site. If you'd like to take part, then take a look at the options above and get crackin'!
The Rails Documentation Project is a community project to document the Ruby On Rails web development framework.
All content is licensed under the MIT License, unless specified otherwise (as much of it is).
The Rails Documentation Project is sponsored by Caboose.