I don't understand why is everyone trying to come up with the Mother
of all Documentation Systems all the time. For the time being, can't
we just agree on having two documentation standards for Chicken: wiki
(for simple documentation) and eggdoc (for complex documentation with
examples, tutorials, etc.). Then we could gradually add eggdoc-like
markup to stream-wiki to the point where it would be easy to write a
script that automatically converts eggdoc to wiki. Of course, this
still doesn't solve the problem with not having the documentation
available in the SVN repository. So any automatic operation on the
repository, such as building Debian packages for the eggs cannot work
without manual intervention. Unless someone has a very clear and
detailed idea about to deal with this, I will ask you to defer
grandiose ideas about converting all documentation in the world to the
ultimate and bestest format.
-Ivan
Elf <address@hidden> writes:
putting in my two cents (sorry for the delay, i didnt read the list today yet)
...
i am working on a documentation system to replace eggdocs, straight-wiki, and
chicken-man simultaneously. this is not to say or imply in any way that there
wont be web files on callcc! the goal of the system is to be able to generate
the documentation for chicken in any form, searchable via net or within the
interpreter or as a pdf or texi or WHATEVER, while enforcing some consistency
in presentation. this will (hopefully) make it easier to a) document
both eggs and core, b) keep the documentation up to date, c) reduce
duplication of effort, and d) reduce the learning curve. this is NOT
a replacement for the
wiki, however; certain things can and SHOULD be wikiised.
a full (semi)formal specification will follow, hopefully later tonight. the
specification is intended as an rfc, not as an elf-says-so-its-set-in-stone,
obviously.
-elf