From c9c71ed58893df0551a77e237b18a1a81827c2cb Mon Sep 17 00:00:00 2001
From: Benson Muite <benson_muite@emailplus.org>
Date: Jan 16 2023 04:57:32 +0000
Subject: Initial outline for documentation generators


---

diff --git a/guidelines/modules/ROOT/pages/Documentation.adoc b/guidelines/modules/ROOT/pages/Documentation.adoc
new file mode 100644
index 0000000..8c9e3d9
--- /dev/null
+++ b/guidelines/modules/ROOT/pages/Documentation.adoc
@@ -0,0 +1,30 @@
+= Documentation
+	
+:toc:
+	
+:toclevels: 4
+	
+== Suggested Best Practice
+
+Many packages have documentation automatically generated from
+annotated source files. Where possible man pages should be
+generated and included in the package.
+
+=== HTML documentation
+HTML documentation can also often be generated. This should be
+placed in a separate subpackage, preferably with the name
+`package-name-html-docs`. Such documentation often includes
+bundled javascript, fonts and css.  Some of this is specific
+to the package and others are generic to the documentation
+generation system.  Components that are generic to the
+documentation generation system should be placed in a separate
+package and soft linked after HTML documentation generation.
+The separate package should be required by the
+`package-name-html-docs` package.  Guidelines for specific
+documentation generation systems follows.
+
+==== Doxygen
+
+==== RDoc
+
+==== Sphinx