Re: Some more? (was: Re: My Best Ruby Documentation Suggestion)

On 8/21/05, Benedikt Heinen <[email protected]> wrote:
> 
> I also have a couple of suggestions to (IMHO) improve the situation -

And here I was, thinking I was completely insane.. trying to figure
out a way to express a gateway between a content management system and
a revision-controlled codebase so that the code documentation, online
documentation and even various downloadable documentation could all be
sync'd from the same source.. an easily-editable wiki.  Ruby
uber-docs.

The next step would be to bind it to gems, so that a user can easily
update their local copy of the ruby uber-docs.. so that every app that
uses the ruby uber-docs gets automagically updated.


This wiki would need to have three tabs for every article.

1. The official milestone (with access to previous milestones).  This
is not editible, but is checked out by administrators from the user
contributions.

2. An ever-evolving user-contributed page.  Apply whatever wiki access
logic or other systems to this.  Require logins or not.. whatever you
like.  This would be the publically editable portion of things.

3. Discussion.  Either just another page and/or linked to bulletin
board-style threaded discussions made from a gateway to this ruby-doc
mailing list.


Documentation would then be wrapped up out of all those trusted
milestones, available for synchronization with the Ruby distribution
or with some sort of gems-enabled user database.


I'd participate in such an endeavour.  Ok, I'd participate in its use,
not creation.  =)  *newbie aura*

Frankly I think a tweak to mediawiki would do this.  Just design the
milestoning page concept for another tab to each page.. and anything
fancy can be done with PHP extensions, including designing a Ruby
gateway via php and extensions to do whatever you want.

I talk like this because NO, unless some serious black magic has been
practiced recently, ruby wikis are not very good at all.  I know of
instiki and ruwiki and one or two others which are mostly in Japanese.

(And would I participate in a ruby wiki?  Not unless it eclipses
mediawiki.. including perfect importing of my existing stuff)