doc project: Jamie delivers, Jeremy comes on board
Courtenay : February 21st, 2007
Jamie “fearoffish” has been elbow-deep in the rails API documentation, developing a plan and getting down to the task of actually writing. In the interests of full disclosure, he’ll be getting paid the daily rate of £225 (which is about $450 USD) as will all the documenters.
Part of his first day was spent collaborating with the other author (see below), DHH, and other interested parties, planning out what needs to be documented, and to make sure effort isn’t wasted. Basically, the plan is to write voluminous examples and fix the outdated code. Finally, we trawled through the rails-talk mailing list to find some of the most common questions.
Here are the patches Jamie completed.
- http://dev.rubyonrails.org/ticket/7590 - adding more examples to database.yml
- http://dev.rubyonrails.org/ticket/7591 - adding smtp configuration example to environment.rb. Since smtp is now the default in rails, this one makes sense to have in there
- http://dev.rubyonrails.org/ticket/7618 - better documentation on form helpers. lots of good examples in here.
another author!
Jeremy McAnally is the second author to devote a day a week to the project. You may know him from the “Humble little ruby book”.
2 Responses to “doc project: Jamie delivers, Jeremy comes on board”
Sorry, comments are closed for this article.
February 21st, 2007 at 08:06 PM
This idea might be a little off to include in the rails documentation…but I would love a section that includes how to leverage rails-specific things…outside of rails.
For example a neat rails plugin – being able to use that in a ruby program without having to create and reference a rails directory.
ActiveRecord is pretty straight forward to use outside of rails, but there are other things that aren’t as straight forward.
Just a thought.
Cheers, Henry
February 26th, 2007 at 06:31 PM
Yay! Yay!