Rails Edge Docs: Do it yourself documentation

There are a couple sites which host RDOC for Rails Edge (Planet Argon and Caboose are the ones that come to mind first). The problem is that Rails Edge isn’t just one version of software. It is the group name of all subversion iterations of Rails past 1.2.3, so there may be some discrepancies as features and bugs have been ironed out.

<p>For many problems, there is a simple solution.  And fortunately, this problem has a simple one as well.  The best part is that a former employee of <a href="http://www.planetargon.com">Planet Argon</a>, <a href="http://www.jvoorhis.com/articles/2006/10/19/a-rails-documentation-trick">Jeremy Voorhis</a>, is the one who tipped me off to this.</p>


<p>To get the customized set of RDocs for your particular version of Rails, all you need is:</p>


<ul>
<li><a href="http://www.jvoorhis.com/media/documentation.rake">documentation.rake</a></li>
    <li><a href="http://svn.jamisbuck.org/rdoc-templates/jamis.rb">jamis.rb</a></li>
</ul>


<p>Put the jamis.rb in your <span class="caps">RAILS</span>_ROOT/doc directory, and the documentation.rake into your lib/tasks directory.  This gives you access to a new task, &#8220;doc:all&#8221;.</p>


<p>Now you can use the open a local page function of your web browser to view the newly created docs in your <span class="caps">RAILS</span>_ROOT/doc folder.</p>