[JDEV] Technical Documentation

[temas]

Right now we're on our push towards 1.0.  One of the major steps for 1.0 is
having the documenation, white papers, comments, et all in place.  Currently
I have plans for many white papers and technical documents, and Eliot (e-t)
is working on end user type documentation.  One thing I don't have time for
at the moment is definately comments in the src.  Jer doesn't have the time
either, so if you want to take that up, it would be a very noble task, and
would generally help you familiarize yourself with the src.  I can look over
the comments as they head into cvs to make sure all is on track.  If you 
really want to do this, then jump on IRC (irc.linux.com) #jabber, and talk 
to myself or jer.  We can get you cvs access and on the right path.

--temas

On Fri, Mar 31, 2000 at 11:44:06AM -0800, Colin Putney wrote:
> Agreed, though I'll put a different twist on it. I think general "white
> paper" type documentation should be the priority here. In reading
> through the sources, I've found that all those trees make it really
> difficult to see the forest. It's usually not to tough to figure out
> what a particular function does, but building a picture of the overall
> structure requires a lot of back and forth between different libraries
> and source files.
> 
> I'd like to see a short document describing the following:
> 
> * The overall architecture of the server
> * The execution model (threads, events and synchronization issues)
> * The major data stuctures and memory management
> * Modules and services: the roles they play and the differences between
> them
> * The life cycle of a session
> * The organization of the code
> 
> <introduction>
> I stumbled across Jabber recently while thinking/reading about
> distributed protocols. I really like the whole model (and HATE the
> other IM options available) so I'd like to put my shoulder to the wheel
> and help out. 
> 
> Eventually I'd like to write a good Mac client, but at the moment I
> don't have the necessary tools. I'm also interested in the server side,
> so I going to concentrate on the core and server for now. 
> </introduction>
> 
> I've read through the docs on the web site pretty thoroughly and now
> I'm on to the source code for the 0.9 release. I've been thinking I'd
> get my feet wet by fixing bugs and adding comments to the sources, but
> I'm open to suggestions. What's on the agenda now that 0.9 is out? What
> needs to be done the most?
> 
> BTW congratulations to the Jabber Team for the work done so far. The
> whole architecture seems VERY well thought out. Way cool!
> 
> Colin
> 
> 
> ---------------------------------------------
> Colin Putney         cputney at whistler.net
> Whistler Networks    http://www.whistler.net/
> 
> _______________________________________________
> jdev mailing list
> jdev at jabber.org
> http://mailman.jabber.org/listinfo/jdev
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 232 bytes
Desc: not available
URL: <https://www.jabber.org/jdev/attachments/20000331/9d855fd8/attachment-0002.pgp>