Re: Portscanner class

Martin Jansen wrote: > > On Fri, 16 Nov 2001 14:26:00 -0500 (EST), Joao Prado Maia wrote: > > >Another thing is the problem of the contributors. I think it is a fair > >assumption to believe that most non-CVS PEAR authors that want to add > >their classes to the pear.php.net repository will not want to spent the > >extra effort to learn how to document stuff in our Dockbook standard if > >they already have something in plain HTML, or TXT (or whatever format they > >may choose). > > > >This is why I'm suggesting storing in the /manual only the documentation > >of the 'PEAR Foundation Classes', > > Suggestion: Documentation of the PEAR foundation code goes to /manual. > If an author (like me e.g.) wants to document his code in Docbook, > he can also put that on pear.php.net. If he does not want to do so, > he can put it wherever he wants. I really don't think a monolithic manual is the way to go. When you install a package, you should have documentation installed locally too. And then you should have the documentation for the release/version you have installed, not a huge manual with whatever version the pear manual maintainer sees fit to include. IMHO the PEAR manual should document the basics: what PEAR is, how to install packages, how to upgrade stuff and so on. Everything that is distributed in a package should be documented on its own. We could have a URL scheme for easily locating the manual for a package, for example: http://pear.php.net/doc/ - index of available packages and languages http://pear.php.net/doc/en/ - index of packages documented in English http://pear.php.net/doc/en/Net_NNTP/ - index of Net_NNTP releases http://pear.php.net/doc/en/Net_NNTP/1.0/ - docs for release 1.0 http://pear.php.net/doc/en/Net_NNTP/1.1/ - docs for release 1.1 http://pear.php.net/doc/en/Net_NNTP/stable/ - link/redirect to the latest stable version's docs - Stig