[dev] Fancy Horde/Imap_Client documentation

Michael M Slusarz slusarz at horde.org
Tue Jun 18 20:43:40 UTC 2013


Quoting Michael M Slusarz <slusarz at horde.org>:

> Quoting Jan Schneider <jan at horde.org>:
>
>> So this is the workflow:
>> 1) Editing in the wiki: http://wiki.horde.org/Doc/Dev/HordeArgv
>> 2) Converting to reST:  
>> http://wiki.horde.org/Doc/Dev/HordeArgv?actionID=export&format=rst
>> 3) Bundling with PEAR package:  
>> http://git.horde.org/horde-git/-/browse/framework/Argv/doc/Horde/Argv/
>> 4) Building for website:  
>> http://www.horde.org/libraries/Horde_Argv/docs/README
>>
>> Steps 2-4 are supported by horde-component.
>
> ...except this is not what I am looking for.  This:
>
> http://www.horde.org/libraries/Horde_Argv/docs/README
>
> is not a useful format for *advertising* a component, IMHO.
>
> I am NOT trying to document the entire library.  I'm trying to draw  
> people into using it - or at least getting the word out.  I just  
> don't think reST is appropriate for this.  At least that's what  
> potential clients are telling me.

Let me make clear: I have no problems trying to prevent duplication of  
effort/documentation.  What I am saying is that I don't think the  
current setup is working at all in terms of presenting our products.

And that's not my opinion -- that's the feedback I've received from  
two different potential clients the last couple of months.

michael

___________________________________
Michael Slusarz [slusarz at horde.org]



More information about the dev mailing list