Re: package pages
| From: | Pierre-Alain Joye | Date: | Mon, 07 Oct 2002 13:34:32 +0000 |
| Subject: | Re: package pages | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-9921@lists.php.net to get a copy of this message | ||
On Mon, 07 Oct 2002 14:33:35 +0100
Michael Dransfield <mike@blueroot.net> wrote:
> I agree, but there is also a lot of confusion about where and how to
> write documents. For example, I was under the impression that the
> comments in our code would be extracted to form the docs on the pear
> website, then I find out that I need to copy this into docBook format
> (something I know next to nothing about), then there is a doc
> directory which contains html, txt and any other format that the
> author felt like using.
>
> One of the main benefits of php is the great documentation, I wouldnt
> like to see this lost with pear.
>
> Oh, and I agree that a project page would be nice (for PEAR
> developers), so long as it wasnt a replacement for good documentation.
Project page is a good idea : +1
About documentations and references, we have got a discussion (during
the summer, check the archives ;-) ). We can see 2 different docs, the
dev reference (from phpdoc) and tutorials/enduser doc. I ll like to see
the last one in XML docbook (do not talk about sgml please :-), we can
convert it later), easy to write on our common word processor and
convert it to whatever we need.
hth
pa