update documentation for configuration file

Author: yasunariw

README.md

@@ -20,8 +20,7 @@ and use resulting `_build/default/src/notabot.exe` binary.
 
 ## Running
 
-Configuration is read at startup from `notabot.json` and `secrets.json` files
-according to `lib/notabot.atd` schema.
+At startup time, secrets are read from the local `secrets.json` file. The main configuration is read remotely from a `notabot.json` file in the default branch, and its schema is defined in `lib/notabot.atd`.
 
 ### Documentation
 

documentation/config_docs.md

@@ -36,15 +36,16 @@ Config file is where the variables affecting the behaviour of notabot are define
 **example**
 ```json
 "status_rules": {
-    "name": [
+    "title": [
         "default",
         "buildkite/pipeline2"
     ],
     "status": {
         "pending": false,
-        "success": true,
+        "success": "once",
         "failure": true,
-        "error": true
+        "error": true,
+        "cancelled": "^\\(Build #[0-9]+ canceled by .+\\|Failed (exit status 255)\\)$"
     }
 },
 ```
@@ -56,7 +57,16 @@ Config file is where the variables affecting the behaviour of notabot are define
 
 ### Status State
 
-A json object with fields of bools for each status type. Set them to true to suppress status of that type.
+A json object with fields of bools for each status type.
+
+| value | description | optional | default |
+|-|-|-|-|
+| `pending` | `true` to notify; `false` to ignore | No | - |
+| `success` | `true` to notify; `false` to notify all; `"once"` to notify the first and ignore subsequent consecutive successes| No | - |
+| `failure` | `true` to notify; `false` to ignore | No | - |
+| `error` | `true` to notify; `false` to ignore | No | - |
+| `cancelled` | provide regex to ignore `failure` notifications with a description that matches it | Yes | - |
+
 
 ## Label Config
 

test/notabot.json

@@ -2,7 +2,7 @@
     "offline": "github-api-cache",
     "main_branch_name": "develop",
     "status_rules": {
-        "name": [
+        "title": [
             "default",
             "buildkite/pipeline2"
         ],