From: Brian Tol <wiremine@...>
Date: 2007-07-27T10:35:56+09:00
Subject: [ANN] Rubypub.com - A Ruby Documentation Wiki

[ANN] Rubypub.com - A Ruby Documentation Wiki

Rubypub.com is custom-built documentation wiki for Ruby Gems. Features of note:

1. It's loosely based on rdoc's HTML output, although hopefully a bit
nicer to look at.
2. Every README, module/class rdoc and method rdoc is editable. Other
files (docs, mostly) are included, too, though not in edible form.
3. 7,134 total gems are available, with 1,817 being newest releases.
New gems are imported nightly.
4. Every file from every gem is included at files.rubypub.com, and all
the Ruby files are HTMLized [1].

Rubypub's hopes/dreams are twofold:

1. Provide a single-source web site for Gem documentation, making it
easier for Ruby programmers to find documentation. It also offloads a
bit of work from gem authors: they don't need to remember to publish
their rdocs.
2. Allow everyone to easily contribute documentation, and offer that
documentation back to gem authors for incorporation into their
codebases and online docs.

Rubypub is part labor of love, part social experiment. The best case
scenario: it allows the ruby community to produce incredible
documentation extremely fast. Worse case: it makes bad documentation
worse.

There's a few bugs, and probably more than a few warts, but it's
hopefully far enough along to get feedback.

Near-term goals:

1. Nail down the licensing policy. Currently user-contributed
documentation is distributed under a Creative Commons
Attribution-ShareAlike 3.0 Unported Licence, except where doing so
would conflict with the original licensing terms. This seems fair, but
feedback is very much appreciated, as I'm not a licensing guru.
2. Stamp out the bugs and finish a few outstanding features. Please
use the Rubypub Google Group [2] to submit issues and submit ideas.
3. Figure out the best method of delivering contributed docs to
authors. XML? JSON? Patches? Ideas are appreciated.

One final note: Hopefully people find this useful. But if you're a gem
author and would prefer not to include your gems at rubypub, I'm happy
to remove them. Just drop me an email.

[1] Here's a sample:
http://files.rubypub.com/activesupport-1.4.2/lib/active_support.rb
[2] http://groups.google.com/group/rubypub