Re: regenerating stdlib docs more frequently/nightly

Sam Roberts wrote:
> James, Gavin -
>
> Judging from your emails, I hear two issues:
>
> GS - that the auto-generated docs might not get generated right, so we'd
> be automatically putting junk on ruby-doc.org
>
> JB - that if we put a new .zip file up every day, people might download
> it every day.. and maybe the docs don't change that fast!
There would not be a zip file.  I've been having an exchange with Huge 
Sasse on ways to facilitate incremental downloads of the api pages when 
something changes.
If there is an update to the Socket class, there is no reason to go grab 
a tarball of the entire set of API docs, just download the pages for 
that class.
Similarly, there should be away to update specific ri files when docs 
are updated.
> I don't generate the entire docset regularly on my machine, I did it
> once, and regenerate specific libs after I've added docs to make sure
> they generate OK. So, there could be problems, but its not possible for
> one guy to check, and no amount of me running it on my machine is going
> to have me say "yep, the docs are good". I've never even looked at some
> of the packages, they could be chop suey inside.
Interesting point.

> Here's a suggestion that might help both issues.
>
> How about the stdlib docs have a "stable" version, and a "nightly"
> version. We can ask that people look at the nightly version, and if
> there are problems, to report them. That way we get all eyes checking,
> and will discover problems faster.
I say just use the automatic build until someone complains.  Then fix 
the part that is broken.
...

> Maybe I'm too optimistic, but I really hope that if docs patches could
> be posted, show up in cvs, and be on the web page faster than we'd get
> more docs posted by volunteers. Also if there was a one-two-three step
> to submitting some docs:
>
> 1 - co src like this...
> 2 - add docs...
> 3 - install stdlib-doc and run ....
> 4 - mail diff -u to ruby-doc@ with subject of ...
Better to diff the source code and submit the changes back to here or 
ruby-core, as the comments need to go in the source anyway, no?
James