I think the existing Jython wiki would serve this purpose pretty well.
Create a top level page "Modules", link to it from the users section
of http://wiki.python.org/jython/FrontPage and add pages off of it for
each module you want to document. I imagine the pieces of information
that trickle in for each module will be different enough that coming
up with some faq structure or system doesn't make sense.
On 3/10/07, Alan Kennedy <jython-dev@...> wrote:
> [James Abley]
> > I have a stream of consciousness regarding unicodedata that I'd like
> > to put somewhere other than my head!
> That's exactly the kind of information that I had in mind. It's all
> fresh in your mind, now that you're implementing it. If it's captured
> on a unicodedata specific page, then that page becomes
> 1. A collection point for the kind of research information that
> doesn't belong in code
> 2. A starting point for potential users to decide whether or not the
> module will match their requirements.
> 3. A starting point for other implementors who want to
> extend/improve/correct the existing functionality.
> As an example of the kind of thing I mean, see this page about socket timeouts
> > Is this an existing resource that we're extending, or a request for
> > something new?
> Well, it could be either I suppose.
> The existing FAQ infrastructure could be used, although I think that
> the kind of detail I have in mind is too much detail for that FAQ. For
> example, how could we map all of the details from the above socket
> timeouts page to the existing FAQ?
> What I would really like to see is a whole wiki page dedicated to each
> module, so that it could be as detailed as the socket page above.
> In terms of infrastructure and maintence, it would only be a single
> wiki instance, e.g. MoinMoin, which is already used extensively on the
> If this doesn't happen, the I do recommend that you write up your
> implementation details on a page like the one above, and host it
> somewhere yourself. It might not be centralised on the jython web
> site, but at least it will turn up in search engines.
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share your
> opinions on IT & business topics through brief surveys-and earn cash
> Jython-dev mailing list