[cldoc-devel] Documentation tools

[Cody Koeninger]

On 12/14/05, Erik Enge <erik.enge at gmail.com> wrote:
>In a month or so, common-lisp.net will automatically generate
>documentation for all projects with a .asd file every night using
><http://common-lisp.net/project/cldoc>.

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