[dev] Fancy Horde/Imap_Client documentation

[Jan Schneider]

Zitat von 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.

It's just one part. Agreed, the docs for Argv are only for  
implementing it, not for advertising it. But that's all about *what*  
we write, not where.
http://www.horde.org/libraries/Horde_Argv/library is where the  
advertising should go, with more detailed documentation in  
http://www.horde.org/libraries/Horde_Argv/docs.

> 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.

I don't understand what reST has to do with this. It's just an  
intermediate format, like the wiki markup. It's designed to be  
readable as-is though, so it's fine for bundling as technical  
documenation with the package. But at this point, the user already  
downloaded the libary and wants to use it, so that's fine.
-- 
Jan Schneider
The Horde Project
http://www.horde.org/