[Mailman-Developers] I want to write docs!
Wed, 9 Feb 2000 22:00:10 +0100
[see below for summary]
I've downloaded Mailman about a week ago, and I'm very excited.
I read all papers.
I read many of the source code.
I read all available documentation.
And now, I want to write documentation.
The TODO list says:
- a detailed feature list
- a user's guide
- a site-admin's guide
- a list-admin's guide
- more in-place documenation
- A developer's guide with architecture and API info, etc.
I want to add one:
- more docstrings in the code
I want to write all kind of documentation.
However, there is no good system for it. I know nothing about setting up
a system like the Python documentation system, or an XML DTD, or...
I do know the DOCBOOK DTD, but I'm not able to get it to work. I don't
know how to tell sgml2html where to search for all the files. I seem to
to something wrong. I can't get it to work.
But I certainly want to write documenation. Plain HTML, however, would
be an awful thing, since we would need to convert it to the other system
after we built such a system.
Another thing: if I add docstrings to the code, what should I do with
the changed code, with the patches? I can't find out where to send
patches to be incorperated in mailman. Neither mailman-cabal, nor this
list seems to be the right place :(.
-----BEGIN SUMMARY BLOCK-----
I want to write documentation, but I don't know how to do it in
practice, e.g., in what format and where to send the docs.
-----END SUMMARY BLOCK-----
-----BEGIN GEEK CODE BLOCK----- http://www.geekcode.com
GCS dpu s-:-- a14 C++++>$ UL++ P--- L+++ E--- W++ N o? K? w--- !O
!M !V PS+ PE? Y? PGP-- t- 5? X? R- tv- b+(++) DI D+ G++ !e !r !y
-----END GEEK CODE BLOCK----- moc.edockeeg.www//:ptth