adding initial description of app

conf.py

@@ -16,6 +16,7 @@
 import sphinx_rtd_theme
 import sphinx_markdown_tables
 from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
 # -- Project information -----------------------------------------------------
 
 project = 'LegumeCHOICE'
@@ -35,6 +36,15 @@
 ]
 
 
+github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+            'url_resolver': lambda url: github_doc_root + url,
+            'auto_toc_tree_section': 'Contents',
+            }, True)
+    app.add_transform(AutoStructify)
+
+
 source_parsers = {
     '.md': CommonMarkParser,
 }

index.rst

@@ -46,5 +46,5 @@ LegumeCHOICE Documentation
    source/data-processing.md
    source/api.md
    source/nginx.md
-
+   source/contribute-to-the-guide.md
 

source/contribute-to-the-guide.md

@@ -0,0 +1,3 @@
+# Documentation
+
+Guidance on how the guide is set-up and how to contribute

source/legume-choice-app.md

@@ -1,6 +1,10 @@
 # Using the App
 
-Some information about how to use the app.
+This section provides an overview of how to get started with the LegumeCHOICE app. The app can be viewed and downloaded [here](https://l-gorman.github.io/legume-choice-client/). To download the application, visit the page. To the right of the URL (in the search bar) there should be a button to download in the app. If you are having trouble downloading the app, try updating your browser.
+
+When using the app, you will be directed to the "information" page. We recommend reading the description of the tool, and downloading the original guide. To navigate between different parts of the application, open the menu using the button in the top-left corner. The pages are arranged in the order that the data should be collected (i.e. begin at the top and work your way down through each item).
+
+Note that there is a toolbar at the top of the page with the categories "Project", "Project Information", "Legume Information", "Data Entry", and "Results". Each category should be followed by "?". "Project" will be followed by the project name, once it is entered by the user. The remaining categories will be marked as complete when the user visits each of the pages.
 
 ## Project Information
 
@@ -11,3 +15,10 @@ Some information about how to use the app.
 ## Results
 
 ## Managing Data
+
+## Limitations
+
+-   The toolbar at the top only indicates whether the minimum amount of data required for submission has been loaded into the application. This does not indicate whether the user has modified or added any extra information.
+-   This application has only been downloaded/used with Firefox and Chrome, it has not been tested with other browsers.
+-   Currently this application is only designed to function on a computer. It is not likely to accomodate the narrower screens of mobiles and tablets.
+-   The mapping tool, found in **Project Information** will only work with internet connection. We recommend mapping the area of interest before going to the field.

source/using-the-guide.md

@@ -1,3 +1,11 @@
-# Using this Guide
+# Using this Documentation
 
-Information about how to use this documentation
+Each section of this documentation is designed to guide each type of user:
+
+-   **Data Collectors**: There are two main sections for data-collectors. [Using the app](legume-choice-app.md) gives information on how to use the Legume-CHOICE application to collect and manage data from a focus group discussion. [Running a focus group](focus-group.md) describes how to set up a focus group for data-collection.
+
+-   **Researchers**: When collecting data, users can decide whether or not to make their data public. The [Public Data](public-data.md) section describes how this data can be accessed, and how it is organised.
+
+-   **Administrators**: [Administrator guidance](administrators.md) gives administrtors information on how they can manage data collected by individual projects.
+
+-   **Developers**: For developers, we recommend beginning with the [overview](developer-overview.md) section. This section will give a general overview of the application. The remaining sections will go into the details of each individual components, including structure, functionality, and limitations.