On Thu, Oct 30, 2008 at 12:52 PM, Daniel Schierbeck
<[EMAIL PROTECTED]> wrote:
>
> Hi everybody
>
> The recent surge in documentation effort, spurred mainly by the Rails
> Guides project, has caused the quality of Rails documentation to
> improve greatly -- at least that's my humble opinion.
>
> There still is a big hole in the online docs for Rails, though -- a
> real, official, in-depth manual, akin to the ones offered by PHP and
> Django.
>
> The guides provide a great foundation for such a manual, essentially
> being a chapter each (although editing and streamlining would be
> necessary.)
>
> Is there a strategy on this area? Should there be?

The guides as a whole are indeed intended to be the 'in depth'
introduction and tutorial for their areas of rails.  With the rdoc
providing the detailed per class/method documentation.  These two
needs are completely different and I think the improvement in both
these areas is enormous.  They'll both, hopefully, continue to improve
as we go along.

What, beyond guides and rdoc, would a central manual be?

Both the guides and the rdoc live alongside the source, and are
maintained by the docrails guys:

http://github.com/lifo/docrails/tree/master

Any suggestions for improvements or editing should be handled through
those channels.

-- 
Cheers

Koz

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Ruby 
on Rails: Core" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to