Tim,

Part of this community is to use Swikis for documenting and discussing
things. The class comments are clearly documentation and should be handled
in the same mood. Reasons for using a Swiki (and go through all the effort
needed):
* enable easy linking of other documentation, including overviews, examples,
tutorials, bug reports, tests, etc.
* enable people to work on the contents of some class comment (or rather:
class documentation) outside of the image. E.g., if I need to report a bug
that's related to some class, I should be able to link that bug report to
that class.
* it's proven technology, providing histories, change logs, author stamps
etc. etc. etc.
* it's simple enough so that the current HTML renderer can deal with it in
relatively straightforward ways (No Magic Required (tm))

Cheers,
  - Andreas

> -----Original Message-----
> From: squeak-dev-bounces at lists.squeakfoundation.org 
> [mailto:squeak-dev-bounces at lists.squeakfoundation.org] On 
> Behalf Of Tim Rowledge
> Sent: Friday, March 07, 2003 8:18 PM
> To: The general-purpose Squeak developers list
> Cc: Tim Rowledge
> Subject: Re: [DOCS] Swiki as a reference manual?
> 
> 
> Rather than using the swiki (and thus needing to go via http and 
> rendering it) why not stick to the older and not yet tried out 
> suggestion of making a simple interface to the sqdb.squeak.info 
> database Duane Maxwell set up?
> I suspect a fairly simple change to browser code can arrange to fetch 
> any appropriate entry IFF the network is open and to send any new or 
> changed entry.
> I'd further suggest that it might be smart to keep _all_ 
> entries (just 
> concatenate them for example) on the server and allow some 
> reviewer to 
> occasionally merge/edit them into a single entry. This would allow 
> anyone to offer what they thought might be an improvement without 
> allowing rampant overwriting without any sort of editorial process.
> 
> tim
> -- 
> tim at sumeru.stanford.edu
> 
>