Re: Documentation
| From: | Martin Jansen | Date: | Wed, 10 Oct 2001 15:19:01 +0000 |
| Subject: | Re: Documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-2242@lists.php.net to get a copy of this message | ||
On Wed, 10 Oct 2001 11:04:00 -0400, Chuck Hagenbuch wrote:
>Quoting "Tomas V.V.Cox" <cox@idecnet.com>:
>
>> I was refering more where to put this doc after a package installation
>> (for all the files marked as role="doc" in package.xml). The idea could
>> be to setup a new php constant PEAR_DOC_DIR. There we could place docs
>> in a flat structure (like the one we have in the "pear" module):
>>
>> PEAR_DOC_DIR
>> |
>> +-Net_Ping
>> +-Net_NNTP
>> +-...
>
>+1
I also like this structure.
>> For this, we could build a new package in CVS (as you proposed) for ex:
>> pear/peardoc (I'll prefer the "pear" module). This will be a real
>> package which will contain doc for classes under php4/pear.
>
>I think it might be better to keep the doc sources with the packages
>themselves. That way there isn't such a divide between packages in pear
>cvs, php4/pear (which should be going away when the installer is primt-
>time ready), and seperately distributed packages.
+1. The only places, where all docs should come together, should be
the website and PEAR_DOC_DIR.
- Martin