[zeromq-dev] Documentation Proposal

[Martin Sustrik]

Pieter Hintjens wrote:
> On Fri, Jul 9, 2010 at 10:05 PM, Pieter Hintjens <ph at imatix.com> wrote:
> 
>>> In 0mq's case, generated docs are only needed for internal
>>> documentation for contributers. But, for the sake of limiting
>>> complexity, I'd like to keep all documentation under one "umbrella"
>>> with an large emphasis on appropriate cross-referencing and indexing.
>> This won't happen.
> 
> To be clear, I meant this won't happen except via the www.zeromq.org
> site.  I'll reiterate why Wikidot is our choice for the collective
> documentation:
> 
> * it's a tool we know well
> * It has a good permissions model covering anonymous, registered,
> member, and moderator levels.
> * It lets us mix all types of content, from blogs, comments, forums,
> to wiki pages.
> * It notifies editors and watchers of changes.
> * It has full wiki functionality including history, undo, diffs, etc.
> * It lets us upload files and embed other media.
> * Etc.

What about the generated documentation though?

Wikidot doesn't provide a way to upload html pages (as generated by 
asciidoc) therefore the files are manually scp'd to the web server atm.

What Peter have done is generated documentation for 0MQ codebase (as 
opposed to API) which falls into the same category.

Martin