Doc improvements

* Reorganize some main readme contents into separate docs
* Add full bot authentication guide
* Add screenshots and web interface section

Some link fixes and clarifications

Fix another link

Fix another link

More doc cleanup

More doc cleanup

More doc cleanup

Add link to docs in main readme summary

docs/README.md

@@ -16,13 +16,14 @@
 * [Common Resources](#common-resources)
   * [Activities `window`](#activities-window)
   * [Comparisons](#thresholds-and-comparisons)
+  * [Activity Templating](/docs/actionTemplating.md)
 * [Best Practices](#best-practices)
 * [Subreddit-ready Configurations](#subreddit-ready-configurations)
 * FAQ
 
 ## Getting Started
 
-Review **at least** the **How It Works** and **Concepts** below and then head to the [**Getting Started documentation.**](/docs/gettingStarted.md)
+Review **at least** the **How It Works** and **Concepts** below and then head to the [**Getting Started documentation.**](/docs/gettingStartedMod.md)
 
 ## How It Works
 
@@ -32,7 +33,7 @@ RCB's lifecycle looks like this:
 
 #### 1) A new event in your subreddit is received by RCB
 
-The events RCB watches for are configured by you. These can be new modqueue items, submissions, or comments.
+The events RCB watches for are configured by you. These can be new modqueue/unmoderated items, submissions, or comments.
 
 #### 2) RCB sequentially processes each Check in your configuration
 
@@ -125,7 +126,7 @@ For detailed explanation and options of what individual Actions can do [see the
 
 ### Filters
 
-TODO
+authorIs/itemIs TODO
 
 ## Configuration
 

docs/actionTemplating.md

@@ -0,0 +1,72 @@
+Actions that can submit text (Report, Comment) will have their `content` values run through a [Mustache Template](https://mustache.github.io/). This means you can insert data generated by Rules into your text before the Action is performed.
+
+See here for a [cheatsheet](https://gist.github.com/FoxxMD/d365707cf99fdb526a504b8b833a5b78) and [here](https://www.tsmean.com/articles/mustache/the-ultimate-mustache-tutorial/) for a more thorough tutorial.
+
+All Actions with `content` have access to this data:
+
+```json5
+
+{
+    item: {
+        kind: 'string', // the type of item (comment/submission)
+        author: 'string', // name of the item author (reddit user)
+        permalink: 'string', // a url to the item
+        url: 'string', // if the item is a Submission then its URL (external for link type submission, reddit link for self-posts)
+        title: 'string', // if the item is a Submission, then the title of the Submission,
+        botLink: 'string' // a link to the bot's FAQ
+    },
+    rules: {
+        // contains all rules that were run and are accessible using the name, lowercased, with all spaces/dashes/underscores removed
+    }
+}
+
+```
+
+The properties of `rules` are accessible using the name, lower-cased, with all spaces/dashes/underscores. If no name is given `kind` is used as `name` Example:
+
+```
+
+"rules": [
+  {
+    "name": "My Custom-Recent Activity Rule", // mycustomrecentactivityrule
+    "kind": "recentActivity"
+  },
+  {
+    // name = repeatsubmission
+    "kind": "repeatActivity",
+  }
+]
+
+```
+
+**To see what data is available for individual Rules [consult the schema](#configuration) for each Rule.**
+
+#### Quick Templating Tutorial
+
+As a quick example for how you will most likely be using templating -- wrapping a variable in curly brackets, `{{variable}}`, will cause the variable value to be rendered instead of the brackets:
+
+```
+
+myVariable = 50;
+myOtherVariable = "a text fragment"
+template = "This is my template, the variable is {{myVariable}}, my other variable is {{myOtherVariable}}, and that's it!";
+
+console.log(Mustache.render(template, {myVariable});
+// will render...
+"This is my template, the variable is 50, my other variable is a text fragment, and that's it!";
+
+```
+
+**Note: When accessing an object or its properties you must use dot notation**
+
+```
+
+const item = {
+    aProperty: 'something',
+    anotherObject: {
+        bProperty: 'something else'
+    }
+}
+const content = "My content will render the property {{item.aProperty}} like this, and another nested property {{item.anotherObject.bProperty}} like this."
+
+```

docs/botAuthentication.md

@@ -0,0 +1,94 @@
+**Note:** This is for **bot operators.** If you are a subreddit moderator check out the **[Getting Started Guide](/docs/gettingStartedMod.md)**
+
+Before you can start using your bot on reddit there are a few steps you must take:
+
+* Create your bot account IE the reddit account that will be the "bot"
+* Create a Reddit application
+* Authenticate your bot account with the application
+
+At the end of this process you will have this info:
+
+* clientId
+* clientSecret
+* refreshToken
+* accessToken
+
+**Note:** If you already have this information you can skip this guide **but make sure your redirect uri is correct if you plan on using the web interface.**
+
+# Table Of Contents
+
+* [Creating an Application](#create-application)
+* [Authenticate Your Bot](#authenticate-your-bot-account)
+  * [Using RCB OAuth Helper](#rcb-oauth-helper-recommended)
+  * [Using Aardvark OAuth Helper](#aardvark-oauth-helper)
+* [Provide Credentials to RCB](#provide-credentials-to-rcb)
+
+# Create Application
+
+Visit [your reddit preferences](https://www.reddit.com/prefs/apps) and at the bottom of the page go through the **create an(other) app** process.
+* Give it a **name**
+* Choose **web app**
+* If you know what you will use for **redirect uri** go ahead and use it, otherwise use **http://localhost:8085** for now
+
+Click **create app**.
+
+Then write down your **Client ID, Client Secret, and redirect uri** somewhere (or keep this webpage open)
+
+# Authenticate Your Bot Account
+
+There are **two ways** you can authenticate your bot account. It is recommended to use the RCB oauth helper.
+
+## RCB OAuth Helper (Recommended)
+
+This method will use RCB's built in oauth flow. It is recommended because it will ensure your bot is authenticated with the correct oauth permissions.
+
+### Start RCB with Client ID/Secret
+
+Start the application while providing the **Client ID** and **Client Secret** you received. Refer to the [operator config guide](/docs/operatorConfiguration.md) if you need help with this.
+
+Examples:
+
+* CLI - `node src/index.js --clientId=myId --clientSecret=mySecret`
+* Docker - `docker run -e "CLIENT_ID=myId" -e "CLIENT_SECRET=mySecret" foxxmd/reddit-context-bot`
+
+Then open the RCB web interface (default is [http://localhost:8085](http://localhost:8085))
+
+Follow the directions in the helper to finish authenticating your bot and get your credentials (Access Token and Refresh Token)
+
+## Aardvark OAuth Helper
+
+This method should only be used if you cannot use the [RCB OAuth Helper method](#rcb-oauth-helper-recommended) because you cannot access the RCB web interface.
+
+* Visit [https://not-an-aardvark.github.io/reddit-oauth-helper/](https://not-an-aardvark.github.io/reddit-oauth-helper/) and follow the instructions given.  
+  * **Note:** You will need to update your **redirect uri.**
+* Input your **Client ID** and **Client Secret** in the text boxes with those names.
+* Choose scopes. **It is very important you check everything on this list or RCB may not work correctly**
+    * edit
+    * flair
+    * history
+    * identity
+    * modcontributors
+    * modflair
+    * modposts
+    * modself
+    * mysubreddits
+    * read
+    * report
+    * submit
+    * wikiread
+    * wikiedit (if you are using Toolbox User Notes)
+* Click **Generate tokens**, you will get a popup asking you to approve access (or login) -- **the account you approve access with is the account that Bot will control.**
+* After approving an **Access Token** and **Refresh Token** will be shown at the bottom of the page. Save these to use with RCB.
+
+# Provide Credentials to RCB
+
+At the end of the last step you chose you should now have this information saved somewhere:
+
+* clientId
+* clientSecret
+* refreshToken
+* accessToken
+
+This is all the information you need to run your bot with RCB.
+
+Using these credentials follow the [operator config guide](/docs/operatorConfiguration.md) to finish setting up your RCB instance.

docs/operatorConfiguration.md

@@ -20,9 +20,11 @@ The minimum required configuration variables to run the bot on subreddits are:
 * refreshToken
 * accessToken
 
-However, only **clientId** and **clientSecret** are required to run the **oauth helper** mode for generate the last two
+However, only **clientId** and **clientSecret** are required to run the **oauth helper** mode in order to generate the last two
 configuration variables.
 
+Refer to the **[Bot Autentication guide](/docs/botAuthentication.md)** to retrieve the above credentials.
+
 # Defining Configuration
 
 RCB can be configured using **any or all** of the approaches below. **At each level ALL configuration values are
@@ -35,8 +37,7 @@ configuration.
   specified with `--file` cli argument)
 * **ENV** -- Any already existing environment variables (exported on command line/terminal profile/etc.)
 * **FILE** -- Values specified in a JSON configuration file using the structure shown below (TODO example json file)
-* **ARG** -- Values specified as CLI arguments to the program (see [Usage](/README.md#usage)
-  or `node src/index.js run help` for details)
+* **ARG** -- Values specified as CLI arguments to the program (see [ClI Usage](#cli-usage) below)
 
 In the below configuration, if the variable is available at a level of configuration other than **FILE** it will be
 noted with the same symbol as above. The value shown is the default.
@@ -205,6 +206,61 @@ const config = {
 }
 ```
 
+## CLI Usage
+
+Running RCB from the command line is accomplished with the following command:
+
+```bash
+
+node src/index.js run
+
+```
+
+Run `node src/index.js run help` to get a list of available command line options (denoted by **ARG** above):
+
+<details>
+
+```
+Usage: index [options] [command]
+
+Options:
+  -h, --help                                   display help for command
+
+Commands:
+  run [options] [interface]                    Monitor new activities from configured subreddits.
+  check [options] <activityIdentifier> [type]  Run check(s) on a specific activity
+  unmoderated [options] <subreddits...>        Run checks on all unmoderated activity in the modqueue
+  help [command]                               display help for command
+
+
+Options:
+  -c, --operatorConfig <path>   An absolute path to a JSON file to load all parameters from (default: process.env.OPERATOR_CONFIG)
+  -i, --clientId <id>           Client ID for your Reddit application (default: process.env.CLIENT_ID)
+  -e, --clientSecret <secret>   Client Secret for your Reddit application (default: process.env.CLIENT_SECRET)
+  -a, --accessToken <token>     Access token retrieved from authenticating an account with your Reddit Application (default: process.env.ACCESS_TOKEN)
+  -r, --refreshToken <token>    Refresh token retrieved from authenticating an account with your Reddit Application (default: process.env.REFRESH_TOKEN)
+  -u, --redirectUri <uri>       Redirect URI for your Reddit application (default: process.env.REDIRECT_URI)
+  -t, --sessionSecret <secret>  Secret use to encrypt session id/data (default: process.env.SESSION_SECRET || a random string)
+  -s, --subreddits <list...>    List of subreddits to run on. Bot will run on all subs it has access to if not defined (default: process.env.SUBREDDITS)
+  -d, --logDir [dir]            Absolute path to directory to store rotated logs in. Leaving undefined disables rotating logs (default: process.env.LOG_DIR)
+  -l, --logLevel <level>        Minimum level to log at (default: process.env.LOG_LEVEL || verbose)
+  -w, --wikiConfig <path>       Relative url to contextbot wiki page EX https://reddit.com/r/subreddit/wiki/<path> (default: process.env.WIKI_CONFIG || 'botconfig/contextbot')
+  --snooDebug                   Set Snoowrap to debug. If undefined will be on if logLevel='debug' (default: process.env.SNOO_DEBUG)
+  --authorTTL <s>               Set the TTL (seconds) for the Author Activities shared cache (default: process.env.AUTHOR_TTL || 60)
+  --heartbeat <s>               Interval, in seconds, between heartbeat checks. (default: process.env.HEARTBEAT || 300)
+  --softLimit <limit>           When API limit remaining (600/10min) is lower than this subreddits will have SLOW MODE enabled (default: process.env.SOFT_LIMIT || 250)
+  --hardLimit <limit>           When API limit remaining (600/10min) is lower than this all subreddit polling will be paused until api limit reset (default: process.env.SOFT_LIMIT || 250)
+  --dryRun                      Set all subreddits in dry run mode, overriding configurations (default: process.env.DRYRUN || false)
+  --proxy <proxyEndpoint>       Proxy Snoowrap requests through this endpoint (default: process.env.PROXY)
+  --operator <name>             Username of the reddit user operating this application, used for displaying OP level info/actions in UI (default: process.env.OPERATOR)
+  --operatorDisplay <name>      An optional name to display who is operating this application in the UI (default: process.env.OPERATOR_DISPLAY || Anonymous)
+  -p, --port <port>             Port for web server to listen on (default: process.env.PORT || 8085)
+  -q, --shareMod                If enabled then all subreddits using the default settings to poll "unmoderated" or "modqueue" will retrieve results from a shared request to /r/mod (default: process.env.SHARE_MOD || false)
+  -h, --help                    display help for command
+```
+
+</details>
+
 # Example Configurations
 
 ## Minimum Config