|
|
@@ -17,7 +17,7 @@ Documentation is important. It tells users how to use our product, and developer
|
|
|
- Changes to the documentation is **subject to review, just like code changes**.
|
|
|
- Documentation changes are under **version control**.
|
|
|
|
|
|
-How do I add ReadTheDocs to My Project?
|
|
|
+How do I add ReadTheDocs to my project?
|
|
|
---------------------------------------
|
|
|
|
|
|
- Set up your ReadeTheDocs account and add your project integration
|
|
|
@@ -33,5 +33,19 @@ We use RST format to write our documentation. It might seem a little more compli
|
|
|
|
|
|
Link documents to your ``index.rst`` and Sphinx will build you a searchable site with nicely formatted navigation.
|
|
|
|
|
|
-
|
|
|
ReadTheDocs also provides some really awesome **versioning** tools, allowing you to post releases of the documentation so users can go back and find older documentation with almost no effort on your part.
|
|
|
+
|
|
|
+What should my documentation include?
|
|
|
+-------------------------------------
|
|
|
+
|
|
|
+We suggest that your module include the following sections:
|
|
|
+
|
|
|
+- Overview
|
|
|
+- Installation and Setup Guide
|
|
|
+- User's Manual
|
|
|
+
|
|
|
+The Overview section should describe what features your module offers.
|
|
|
+
|
|
|
+The Installation and setup section should guide a site administrator through installing and setting up your module. Any site-wide settings that need to be configured, environmental variables set, or anything else not handled by the automated Drupal install should be covered.
|
|
|
+
|
|
|
+The User's guide should walk through the day-to-day usage of your module. This may include using custom importers, dashboards, or simply summaries of the new content this module provides.
|
bradfordcondon