[slime-devel] Re: Documentation project

[Jeffrey Cunningham]

On Tue Nov 14, 2006 at 08:07:59PM -0800, Jeffrey Cunningham wrote:
> Before I get too far along here, I thought I'd see if I'm on the right
> track. I've attached a pdf I produced after working on the
> documentation for the last few days.
> 
> The biggest additions are two Appendices: a key-bindings index and a
> function index. Entries in both these are linked to anchors where the
> functions are discussed.
> 
> I've added a number of undocumented functions and in the process found
> it difficult to stick to the exact way they were grouped before. So I
> took the liberty of re-arranging some of the subsections slightly and
> adding a couple more.
> 
> Some of the functions have no descriptions - I didn't understand these
> well enough to describe them myself. I will leave these to others to
> document, but the placeholders will be there. 
> 
> I am planning on finishing adding all the functions which are
> accessible directoy, adding a lot more cross-links to anchors, and
> also more examples.
> 
> I assume there is no reason to document internal functions (or is
> there?) 
> 
> Feedback would be helpful. 
> 
> --Jeff
> 


Well, that didn't work - apparently one cannot include attachments in
emails to the list. Here's a link where you can get the attachment:

http://makewavs.com/lisp/slime.pdf

--Jeff