documentation project update

mrneighborly : February 27th, 2007

I just wanted to give everyone an update on the documentation project from my and Jamie's work on Monday. Here is a list of the tickets we've submitted so far.

  • #7590 : More config comments added to database.yml
    This patch adds a signficant piece of information to database.yml pertaining to configuration.
  • #7591 : smtp configuration options added
    Explanation of the smtp options; we're working towards explaining every options hash for every method (ambitious? yes. psychotic? definitely.)
  • #7618 : [ACCEPTED] Better documentation on Form Helpers
    Changed the form helper documentation to be more understanding for beginners.
  • #7651 : Rake annotations searching only in rxml/rhtml files and not builder/erb files (also fix reference to rhtml file in a doc)
    I was working on replacing any reference to rhtml with erb, but while doing so, I noticed a rake task that searched only for rhtml/rxml files rather than rhtml/erb/rxml/builder. So I fixed that while I was at it.
  • #7652 : ActionController::Scaffolding documentation extended and improved
    Greatly extended the Scaffolding documentation, including some information about how to replace scaffolding with your own stuff.
  • #7656 : ActionView::Helpers::PrototypeHelper documentation
    This is much improved PrototypeHelper documentation; I'm still working on this patch. I want to add some documentation explaining what gets generated and fix a few little issues here and there.

Jamie also worked on some much improved ActiveRecord::Base documentation (excited to see that!). We're hoping to turn out a few more patches next week. We're currently working on "high level" documentation, but will eventually get down to documenting the minutia such as option hashes and the like. You can stay posted on what we're doing on the Basecamp that Jamie posted to the caboose blog yesterday.

3 Responses to “documentation project update”

  1. Peter Cooper Says:

    Great work! The addition to environment.rb will be very useful as I’m always having to cut and paste that from somewhere.. :)

  2. Rabbit Says:

    Where are these changes visible? Have they been applied to http://api.rubyonrails.org/ yet?

    Kudos to all those that have contributed!

  3. Jeremy Says:

    No, they are not visible on api.rubyonrails.org yet; the ones that are marked as “ACCEPTED” are the patches that have been accepted into the trunk. I don’t know what the delay is on these patches other than the fact that they are still recovering from the Hackfest. :)

Sorry, comments are closed for this article.