Feat/maintenance page docs (#67)

* Add documentation and definition of maintenance field

* Remove maintenance field in mainnet.json

* Change target branch for testing if schema checks work

* Change base branch back to master

.github/markets/pr_template.md

@@ -12,3 +12,10 @@ Each json file under the [configs](../../configs) folder correspond to their res
 |`blacklisted_tokens`   |`string[]`   |true   |The array of token denoms that are blacklisted. A token can be blacklisted for a number of reasons, such as it being invalid/deprecated/etc. |The token denoms listed here **MUST** match the token denoms listed under the Carbon [Tokens API](https://api.carbon.network/carbon/coin/v1/tokens?pagination.limit=10000). |
 |`transfer_options`   |`object`   |true   |A collection of blockchain networks along with their associated priority numbers, used to establish their order in the transfer options list for deposit and withdrawal forms.   |Blockchain network listed here **MUST** match the valid chainName of the bridges listed under BridgeAll RPC call.<br /><br /> To view the values of BridgeAll RPC call, simply run `yarn get-bridges [network]` on the command line. Sample for mainnet: `yarn get-bridges mainnet`|
 |`network_fees`   |`object`   |true   |List of token denoms along with their associated priority numbers, used to establish their default order in the network fees preference list.   |Token denoms listed here **MUST** match the valid denoms listed under MinGasPriceAll RPC call.<br /><br /> To view the values of MinGasPriceAll RPC call, simply run `yarn get-min-gas-prices [network]` on the command line. Sample for mainnet: `yarn get-min-gas-prices mainnet`|
+|`maintenance`   |`Maintenance`   |false   |Object that dictates whether or not the maintenance page is displayed on each particular network. The maintenance page is displayed when the Carbon chain is down (i.e. blocks are not moving).   | If the `maintenance` property is omitted, the maintenance page will not be shown.
+
+## Maintenance Data Structure
+|Field   |Type   |Required   |Description   |Notes   |
+|---|---|---|---|---|
+|`title`   |`string`   |false   |Title to be shown on the maintenance page   |If not defined, the title defaults to `Service Maintenance`.   |
+|`message`   |`string`   |false   |Description to be shown on the maintenace page (below the title).   |If not defined, the message will default to `Website is temporily unavailable due to planned maintenance. We will be back soon.`.   |

config.schema.json

@@ -66,6 +66,20 @@
         }
       },
       "additionalProperties": false
+    },
+    "maintenance": {
+      "type": "object",
+      "description": "Dictates whether or not the maintenance page is displayed on each particular network.",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Title shown on maintenance page (optional). If not provided, the title of the page will default to \"Service Maintenance\""
+        },
+        "message": {
+          "type": "string",
+          "description": "Description shown on maintenance page (optional). If not provided, the description of the page will default to \"Website is temporily unavailable due to planned maintenance. We will be back soon.\""
+        }
+      }
     }
   },
   "$defs": {

configs/mainnet.json

@@ -93,8 +93,5 @@
     "bneo.1.14.e2e5f6": 20,
     "eth.1.2.942d87": 21,
     "usdc.1.2.343151": 22
-  },
-  "maintenance": {
-    "title": ""
   }
 }