[zeromq-dev] Documentation Proposal

[Peter Alexander]

Hi Pieter

On Fri, Jul 9, 2010 at 1:58 PM, Pieter Hintjens <ph at imatix.com> wrote:
> Peter,
>
> The proposal is interesting. Its unclear how valuable extracted docs are but
> it may work.

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.

The bottom line is, if anyone has a question, any question, I want
them to find the answer quickly and easily. Also, I want them to be
able to drill down in detail to the extent desire.. from the abstract
to the concrete, per se.

> Wikidot does provide an API though I'd keep the wiki for
> hand-written texts.

Yes, but the Wikidot api is not available atm, and they give no
indication when they will revive it, afaik. Besides, Github has a
feature set that is becoming very interesting, ymmv.

>
> The more people think about how to explain 0MQ the better IMO.  So go for it
> and if you need my help, just shout.

Ok, thanks.

>
> -Pieter
>
> Sent from my Android mobile phone.
>
> On Jul 9, 2010 4:32 PM, "Peter Alexander" <vel.accel at gmail.com> wrote:
>
> On Fri, Jul 9, 2010 at 7:30 AM, Peter Alexander <vel.accel at gmail.com> wrote:
>> Abstract
>> =======
>>
> ...
>
> Let me just add here that by disarray I'm referring to 0mq1
> documentation being commingled with 0mq2. Obviously the Man pages,
> Cookbook and new blog entries are quite nice. (hope I didn't
> inadvertently rub anyone wrong :-/ )
>
>>
>> Wikidot is a problem. The api afaik, is broken and renders Wikidot
>> useless imo. See below for...
>
> _______________________________________________
> zeromq-dev mailing list
> zeromq-dev at lists.zeromq.org
> http://lists.zeromq.org/mailman/listinfo/zeromq-dev
>
>