From: Chris N. <pu...@po...> - 2001-11-16 21:41:09
|
At 01:24 -0500 2001.11.16, Micah Yoder wrote: >Not to critisize, but more documentation for Slash would be great. Yep. >Better yet, I think we (the users of Slash) should be doing it. Let the paid >folks keep coding. :-) Yep. >This needn't be hard. When we go through the code and figure something out, >just write it down somewhere. An organized repository would be nice. I may >be able to set something up. What I would like to see first is an outline of the documentation. An outline for the API would be fairly easy. An outline for user/admin docs would be a lot harder. But it would make compiling and extending the documentation you're collecting a lot easier. >It should include readable discussions of the code, explaining the APIs, how >to write plugins, all the troubleshooting tips we can come up with. That >sort of stuff. There is a Slash book coming out, from O'Reilly. I don't know the due date, but it is in production. It is short on API, but long on many other things, and includes how to write plugins, etc. I'd recommend that if you really want to do this, start with the API, then when the book comes out, have the user/admin/troubleshooting docs extend what the book doesn't already have. My three cents, -- Chris Nandor pu...@po... http://pudge.net/ Open Source Development Network pu...@os... http://osdn.com/ |