From c6d34f706b1a4ac3ebc665c27c14dc87b635681c Mon Sep 17 00:00:00 2001
From: "William E. Kempf" <wekempf@cox.net>
Date: Thu, 14 Mar 2002 23:30:00 +0000
Subject: [PATCH] Added links to the writing documentation pages.

[SVN r13199]
---
 index.htm     |  4 ++++
 lib_guide.htm | 10 ++++++----
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/index.htm b/index.htm
index 6fb7e27..429409e 100644
--- a/index.htm
+++ b/index.htm
@@ -38,6 +38,10 @@ content="text/html; charset=iso-8859-1">
     <p><a href="lib_guide.htm"><b>Library Requirements and
     Guidelines</b></a>.&nbsp; Basic standards for those preparing
     a submission.</p>
+	<p><a href="writingdoc\index.html"><strong>Writing
+	Documentation for Boost</strong></a> Basic guidelines
+	for writing documentation and templates for quickly generating
+	documentation that follows the guidelines.</p>
     <p><a href="test_policy.htm"><b>Test Policy and Protocols</b></a>.&nbsp;
     How testing works at Boost.</p>
     <p><a href="submission_process.htm"><b>Library Submission
diff --git a/lib_guide.htm b/lib_guide.htm
index 4f570a0..54ff7a2 100644
--- a/lib_guide.htm
+++ b/lib_guide.htm
@@ -263,18 +263,20 @@ C++ programmer to use the library successfully?</p>
   <li>General introduction to the library.</li>
   <li>Description of each class.</li>
   <li>Relationship between classes.</li>
-  <li>For each function, as applicable, description, requirements
-    (preconditions), effects, post-conditions, returns, and throws.</li>
+  <li>For each function, as applicable, description, requirements (preconditions), 
+    effects, post-conditions, returns, and throws.</li>
   <li>Discussion of error detection and recovery strategy.</li>
   <li>How to use including description of typical uses.</li>
   <li>How to compile and link.</li>
   <li>How to test.</li>
   <li>Version or revision history.</li>
-  <li>Rationale for design decisions.&nbsp; See <a href="#Rationale">Rationale
+  <li>Rationale for design decisions.&nbsp; See <a href="#Rationale">Rationale 
     rationale</a>.</li>
-  <li>Acknowledgements.&nbsp; See <a href="#Acknowledgements">Acknowledgments
+  <li>Acknowledgements.&nbsp; See <a href="#Acknowledgements">Acknowledgments 
     rationale.</a></li>
 </ul>
+<p>If you need more help with how to write documentation you can check out the 
+  article on <a href="writingdoc/index.html">Writing Documentation for Boost</a>.</p>
 <h2>Rationale</h2>
 <p>Rationale for some of the requirements and guidelines follows.</p>
 <hr>