From: Chad Fowler <chad@...>
Date: 2003-11-28T13:42:57+09:00
Subject: Re: Installing Docs (Was Re: Library directory structure on windows)

On Fri, 28 Nov 2003, Jim Weirich wrote:

# Gavin Sinclair wrote:
# 
# > RubyGems, as far as I know, makes no provision for installing
# > documentation.  I was going to offer my services to the owners of this
# > project once it settled down a bit.
# 
# Yours services would be most welcome.  There was a bit of conversation 
# about docs in RubyGems, but left for later once the basics are worked 
# out.  Right now, I'm thinking that the documentation should be stored in 
# the directory where the gem is unpacked.  Pre-generated docs could be 
# part of the gem, or some post installation formatting (e.g. rdoc) could 
# be done.  Then all we have to do is make documentation tools 
# knowledgable about where gems are stored.
# 

To second what Jim said, documentation support was one of the first items 
we discussed.  It was saved until later partially because it's not as 
important as, say, installing code :) and (I think) mostly because it's a 
fairly simple problem to solve.  

The same goes for tests.  A nice side-benefit of specifying this stuff in 
metadata is that a tool such as a gem-friendly RAA can query which 
libraries actually *have* docs and tests.  I might, for example, like to 
filter out libraries that don't have a test suite configured.

Chad