There were a number of people who were keen to do some work on Python documentation - yet after a flurry of conversation, nothing materialized.
What I think would be best is an all-in Freenet user-manual which covered all aspects of Freenet, starting with installation instructions for a variety of operating systems, including information on how Freenet worked, and concluding with information for client writers and such-like. For an idea of the quality of documentation we could aim for, I suggest looking at http://www.python.org/doc/current/ for the Python documentation. There is a module in CVS called "docs" which contains some disorganised and incomplete documentation. There are several choices for what language we document in, Latex is older, Docbook is newer (and XML based). Lyx (a nice graphical document processor) can generate both but works better with Latex in my experience. Both Latex and Docbook can be converted easily to a variety of formats including HTML, postscript, ASCII, MS Word (RTF), and PDF. We need someone to take-on the role of document maintainer and start to work on this, they won't need to write the entire document, but they will be responsible for editing it, and deciding on the overall structure. Ideally, we could create an automatic daily rebuild of the user manual in all of the above formats. Does anyone want to take-on this task? Preferably it should be someone with experience with the tools (latex/docbook) I mention above. Ian. -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: application/pgp-signature Size: 232 bytes Desc: not available URL: <https://emu.freenetproject.org/pipermail/devl/attachments/20010218/f248ee47/attachment.pgp>
