[REBOL] Re: Documentation: Let's do it NOW!
From: maximo:meteorstudios at: 8-Aug-2003 9:20
> -----Original Message-----
> From: Robert M. Muench [mailto:bannarama]
> Sent: Friday, August 08, 2003 3:00 AM
> To: [rebol-list--rebol--com]
> Subject: [REBOL] Documentation: Let's do it NOW!
>
> > rebol.com really needs a search engine, to which we can plug
> > our own information (in any form: web refs, code, text, etc.).
>
> Hi, just a note to all that might not follow Rebol from the beginning.
> There is/was once a Rebol word dictonary Reblet that allowed
> to add your
> own notes to each entry. You had a filter to select the words of some
> category (like GUI, control, logic).
(you mean that the commented code is not a miracle apparition ... ;-) yes that was
cool, and I wonder why it died...
> IMO this is the right way to go. Let's extend this Reblet
> with a central
> P2P synced database that users can download/update.
The system should have a web presence too IMHO, its easier to access anywhere anytime...
that't just about what I proposed, but like I said, I can do db... but I'm lethal with
gfx and gui's...
hey this could be a PERRFECT project for steel... if you wish... I was itching for a
case study to help me focus steel... this is something I'd gladly sponsor within steel,
if the community will let me ;-).
I was thinking to add such an auto documentation engine for steel itself, but I'd rather
participate in a global solution and use that within steel...
maybe we could add a two-layered approach (api + tools) ... one standard engine (like
a standard cgi template if you wish) that ANYONE could use for his own documentation
server/review etc. then, anyone INCLUDING RT could search accross all known and live
doc servers on the net and perform a community wide search of ANY topic ;-)
when servers die (as they are doing for the new links page (you know the little "live"
dodad besides the link) well, they are removed from the list of active servers and no
longer jam the searches...
> New entries should
> pass a peer-review process to get into it. The mailinglist can be used
> to discuss peer review rejected things. The idea of easy-vid,
> easy-draw
> can be used to provide click-able examples. Lots of examples for each
> word!
YESS!
> Further I think such a Reblet would perfectly fit into the library
> project (this doesn't mean that the Library people should do it). The
> dictonary Reblet could be extended with a library Reblet.
If just pathed the library modules into the standard api as I describe above, then they
could add their stuff themselves (actually anyone could, which is the whole point, universal
point of entry) that's what I'm ranting about everytime the topic comes back...
> Anyway, I have written enough and to get things started now I'm doing
> the first step: If no better suited person is found, I'm willing to
> start and manage this project. But I won't do it only myself ;-). So,
> who is going to join the project? Robert
who is going to help US, you mean ;-)
thanks for the inspiration...
-MAx
