From codykoeninger at gmail.com Thu Dec 15 05:33:48 2005 From: codykoeninger at gmail.com (Cody Koeninger) Date: Wed, 14 Dec 2005 23:33:48 -0600 Subject: [cldoc-devel] Documentation tools Message-ID: <4cb996f20512142133n3d723e75x6094c1c712cd07fb@mail.gmail.com> On 12/14/05, Erik Enge wrote: >In a month or so, common-lisp.net will automatically generate >documentation for all projects with a .asd file every night using >. I really like the idea behind this project - docstrings already are (should be) there, so parse them for documentation. 2 concerns: 1. How does one provide a clear "start reading here" or example of usage for the user? Just looking at http://common-lisp.net/project/cldoc/HTMLdoc/index.html without the hint on the homepage, I would have no idea that I should track down the extract-documentation method as a starting point. Is the 'package' link intended to provide that hint? 2. The documentation for CLDOC itself could use a little attention in terms of spelling / grammar (e.g "must note be instancied"). How can I (or another gardener) pitch in on that front? -cody From hatchond at yahoo.fr Thu Dec 15 11:20:42 2005 From: hatchond at yahoo.fr (Iban HATCHONDO) Date: Thu, 15 Dec 2005 12:20:42 +0100 (CET) Subject: [cldoc-devel] Documentation tools In-Reply-To: <4cb996f20512142133n3d723e75x6094c1c712cd07fb@mail.gmail.com> Message-ID: <20051215112042.4484.qmail@web25501.mail.ukl.yahoo.com> --- Cody Koeninger a ?crit : > On 12/14/05, Erik Enge wrote: > >In a month or so, common-lisp.net will > automatically generate > >documentation for all projects with a .asd file > every night using > >. > > I really like the idea behind this project - > docstrings already are > (should be) there, so parse them for documentation. > 2 concerns: > > 1. How does one provide a clear "start reading here" > or example of > usage for the user? Just looking at > http://common-lisp.net/project/cldoc/HTMLdoc/index.html > without the hint on the homepage, I would have no > idea that I should > track down the extract-documentation method as a > starting point. Is > the 'package' link intended to provide that hint? Yes pretty much. But I agree that it is not obvious. I am trying to write up a small example and 'getting started' page for that purpose. > 2. The documentation for CLDOC itself could use a > little attention in > terms of spelling / grammar (e.g "must note be > instancied"). How can > I (or another gardener) pitch in on that front? I would love to have some help on this front ! I know I should be an intensive user of M-x ispell, as a non native english speaker, but I forgot from time to time :) I can either give you CVS right or you you can send me patch I can apply and commit. Cheers, Iban. ___________________________________________________________________________ Nouveau : t?l?phonez moins cher avec Yahoo! Messenger ! D?couvez les tarifs exceptionnels pour appeler la France et l'international. T?l?chargez sur http://fr.messenger.yahoo.com