[REBOL] Re: Documentation: Let's do it NOW!
From: lmecir:mbox:vol:cz at: 10-Aug-2003 10:29
Hi all,
> Gregg:
> > Sunanda has been working on the new
> > submission pieces (you can submit scripts now, but we have to do
> > things manually, and the goal is to automate everything so there's no
> > delay waiting for us to get involved).
>
> Not just me, Gregg and Volker too as the core library team -- and Robert
> Muench is chipping in a chopped Make-Doc-Pro for Library documentation.
>
> I hope we'll have something to show within a month. The improvements we
are
> cooking up will make the Library more interactive, and scripts will be
able to
> have:
>
> ** documentation -- you'll be able to add a script *and* the user manual
or
> "How I wrote this" article or whatever attached to the script. That should
> make scripts easier to use, and make the library more of a place to browse
for
> inspiration and REBOL knowledge, rather than just bare scripts.
this functionality (documentation) has been already achieved at the R.E.P
site ( http://www.compkarori.com/vanilla ). It contains bug data some of us
have written, documentation to some of our scripts, features of Rebol
and more. It is a pity that the library team tries to duplicate the
functionality.
> ** discussion -- anyone can start a discussion thread about a script -- to
> request new functions, report errors, suggest improvements etc. You could
image
> some of the recent discussion about XML parsing hanging off an XML script,
> leading to the final version in the Library being the distillation of many
> people's comments.
This is a functionality already present at the R.E.P. site too.
> ** ownership -- the owner(s) of a script can update it, or the
documentation,
> or moderate the discussion thread hanging from it, without having to go
> through the slow, manual, contribution process we have now.
At the R.E.P. site not just the owner, but everyone can update the
documentation, enhance it etc. I suggest everyone to try to write at least
one piece of information there.
> We've got a fair bit of backroom work to do to enable that, so when I say
I
> hope we'll have something to show in a month, I don't mean everything. But
we
> are whittling away at the outstanding coding tasks.
>
> I'd like to see the Script Library as a nexus for anyone who cares about
> quality REBOL scripts to contribute scripts or ideas or notes. That will
make it a
> very valuable resource for new people learning REBOL.
>
> None of that replaces the ideas discussed in this thread about a
> documentation wiki and other mechanisms. But I think those ideas fit in
well with what we
> have planned.
The documentation wiki idea looks like yet another forking in this area. Did
Robert have a look at the R.E.P. site?
> There's quite a bit of new code in place already on the offline test
system.
> If any one fancies a spot of system testing to help us iron out the bugs,
and
> you have a web-server installed locally on your computer -- please drop me
an
> email.
>
> Thanks!
> Sunanda
-Ladislav
