cvs: peardoc /en/chapters contributing.xml
| From: | Daniel Convissor | Date: | Fri, 09 Apr 2004 17:48:39 +0000 |
| Subject: | cvs: peardoc /en/chapters contributing.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3219@lists.php.net to get a copy of this message | ||
danielc Fri Apr 9 13:48:39 2004 EDT
Modified files:
/peardoc/en/chapters contributing.xml
Log:
Add a section about helping with documentation.
http://cvs.php.net/diff.php/peardoc/en/chapters/contributing.xml?r1=1.9&r2=1.10&ty=u
Index: peardoc/en/chapters/contributing.xml
diff -u peardoc/en/chapters/contributing.xml:1.9 peardoc/en/chapters/contributing.xml:1.10
--- peardoc/en/chapters/contributing.xml:1.9 Mon Oct 6 16:06:15 2003
+++ peardoc/en/chapters/contributing.xml Fri Apr 9 13:48:36 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<chapter id="contributing">
<docinfo>
@@ -137,6 +137,17 @@
</para>
</sect1>
+ <sect1 id="contributing.documentation">
+ <title>Writing Documentation</title>
+ <para>
+ Good documentation is essential for users to fully understand any
+ software. Several PEAR packages lack documentation or have docs which
+ need improvement. <link
+ linkend="developers.contributing.docs">How to document code in
practice</link>
+ provides more information about helping out on this front.
+ </para>
+ </sect1>
+
<sect1 id="contributing.wishlist">
<title>Wishlists</title>
<para>