feat(Website): add website directory with Docusaurus generated doc site. (#3)

* fix(api): fix channel_info_lookup filename

* feat(definitions): updated definitions to match latest versions

* fix(definitons): Add Data definition

* feat(API): updated and consolidated API documentation, removed outdated definitions

* cleanup(Tools): removed Websocket docs, updated Tools to pull m8 doc and remove cli and it

* feat(v0.8.0): updated architecture, tutorial, and examples to v0.8.0

Removed references to outdated objects such as Channel Config, and Accounts.
Updated examples to use m8 tool.
Updated configs to reference latest config such as default port number.

* fix(api): remove duplicate definition on transaction submit response

* fix(api): fix newline markdown spacing

* fix(definitions): fix Data definition header

* cleanup(versioning): remove versioning, store all processed docs in docs directory, remove API Reference

* feat(website): generate Docusaurus site to display docs, add OpenAPI Spec to work with Redoc component

* feat(definitions): remove definitions, used React import of Redoc component from Open API Spec instead

* fix(config): use a number scrollYOffset value

* cleanup(README): update README to use npm

* fix(deps): bump redocusaurus version to fix api page sidebar scrolling issue

* feat(docs): upate docs for mazzaroth v0.8.1 using updated Gateway naming and config values

* fix(config): update config for deployment, check-in package-lock

* fix(config): update links to use duplicate docs routing due to repo name matching docs dir

Author: jeff1010322

Makefile

@@ -1,18 +1,18 @@
 .PHONY: all lint
 
-VERSION = "v0.8.0"
+OUTPUT = "docs"
 
 PROCESS_INPUTS = $(shell find ./preprocessed/ -type f -name '*.md')
 
 # Create a list of all the output files you want to generate
-PROCESS_OUTPUTS := $(patsubst ./preprocessed/%.md, ./$(VERSION)/%.md, $(PROCESS_INPUTS))
+PROCESS_OUTPUTS := $(patsubst ./preprocessed/%.md, ./$(OUTPUT)/%.md, $(PROCESS_INPUTS))
 
 #
 # # The default is to build all the OUTPUTS files
 all: $(PROCESS_OUTPUTS)
 #
 # # Tell make how to build a single output file
-./$(VERSION)/%.md : ./preprocessed/%.md
+./$(OUTPUT)/%.md : ./preprocessed/%.md
 	@mkdir -p "$(@D)"
 	markdown-pp $< -o $@
 

README.md

@@ -1,12 +1,19 @@
 # docs
 
-The latest documentation can be found in the v0.4.2 directory.
+The latest documentation markdown can be found in the `docs` directory.
 
 ## Markdown preprocessor
 
 Markdown files in the preprocessed directory use a [Markdown Preprocessor](https://github.com/jreese/markdown-pp)
 syntax to allow importing modules from other documents and transform the documents
-that are finalized in the versioned directories.
+that are finalized in the docs directories.  So any updates should be made to the
+preprocessed docs.
+
+To build the docs run:
+
+```Bash
+make all
+```
 
 ## Markdown lint
 
@@ -16,20 +23,6 @@ lint rules.
 See [Rules](https://github.com/DavidAnson/markdownlint/blob/v0.20.3/doc/Rules.md)
 for reference.
 
-## Naming Convention
+## Docusaurus
 
-We use a specific naming convention to allow the ToC on the website to be
-formatted correctly. We replace all underscores with spaces in the ToC, and we
-remove everything before the first '-' in the name. The main purpose of this
-is to allow good formatting and ordering in the ToC without also maintaining
-a metadata file. For example 1-Getting_Started.md -> 'Getting Started' in the
-ToC.
-
-The exact logic is:
-
-```Javascript
-let text = parts[1].replace(/_/g, " ").replace(".md", "");
-if (textParts.length > 1) {
-  text = textParts.slice(1).join("-");
-}
-```
+The website directory contains a website built with [Docusaurus](https://github.com/facebook/docusaurus).

definitions/ABI.md

@@ -1,3 +1,8 @@
+---
+sidebar_label: "Getting Started"
+sidebar_position: 1
+---
+
 # Mazzaroth
 
 ## Introduction
@@ -47,18 +52,18 @@ There are currently 3 types of nodes available to be deployed:
 
 - [Standalone](#Standalone) nodes are useful for development, but do not connect
 to the distributed network of consensus nodes.
-- [Readonly](#Readonly) nodes provide users with access to the blockchain
+- [Gateway](#Gateway) nodes provide users with access to the blockchain
 through RPCs but do not participate in consensus.
 - [Consensus](#Consensus) nodes participate in a channel's consensus to
 facilitate ordering and execution of transactions.
 
-The command to start a node is `mazzaroth start` followed by the type.
+The command to start a node is `mazzaroth node start` followed by the type.
 Command line flags may also be provided to override default config values or
 you can use a config yaml file. For example, to start a standalone node with
 a config file you can use the following command:
 
 ```Bash
-mazzaroth start standalone --cfg-path my-config.yaml
+mazzaroth node start standalone --cfg-path my-config.yaml
 ```
 
 For the GCP standalone solution a systemd service is already setup and all that
@@ -71,10 +76,10 @@ A standalone node can be used as a development environment for Mazzaroth.
 It provides a way to deploy and interact with a smart contract without
 connecting to the global network of nodes.
 
-### Readonly
+### Gateway
 
-A readonly node is connected to the network but does not participate in consensus.
-The main role of a readonly node is to allow clients to send requests to the
+A gateway node is connected to the network but does not participate in consensus.
+The main role of a gateway node is to allow clients to send requests to the
 channel including submitting transactions and requesting information from
 the ledger or state.
 
@@ -83,12 +88,12 @@ the ledger or state.
 A consensus node is connected to the network and participates in the consensus
 that accepts transactions into the channel. A consensus node does not allow
 requests from clients, but does receive forwarded transactions from other
-readonly nodes in the network.
+gateway nodes in the network.
 
 ## Interacting with a Node
 
 This guide will walk you through interacting with a Mazzaroth node.
-Standalone and Readonly nodes use HTTP to handle requests and can be used to
+Standalone and Gateway nodes use HTTP to handle requests and can be used to
 deploy contracts, submit transactions, or lookup information from the ledger.
 
 [m8](https://github.com/kochavalabs/m8) is a command line tool

definitions/Block.md

@@ -1,3 +1,8 @@
+---
+sidebar_label: "Account Creation"
+sidebar_position: 2
+---
+
 # Creating Mazzaroth Accounts
 
 All transactions that are submitted to the network will be signed by a private

definitions/BlockHeader.md

@@ -1,3 +1,5 @@
+import ApiSchema from '@theme/ApiSchema';
+
 # Storage
 
 Data is stored by Mazzaroth in a couple of ways. The Mazzaroth Ledger
@@ -65,7 +67,7 @@ efficient and secure verification of the data that it stores.
 For an example of how this is used in Mazzaroth take a look at the fields of a
 Block Header.
 
-!INCLUDE "definitions/BlockHeader.md", 2
+<ApiSchema pointer="#/definitions/BlockHeader" />
 
 Every Block Header contains three Merkle Root Hashes, which correspond to the
 Transaction Merkle Tree, the Receipt Merkle Tree, and the State DB Merkle Tree.

definitions/BlockHeight.md

@@ -27,7 +27,7 @@ against faulty nodes while allowing a distributed network to reach consensus.
 - [PBFT White Paper](http://pmg.csail.mit.edu/papers/osdi99.pdf)
 
 Nodes may join a channel as a Consensus node in order to participate in the
-consensus protocol. Readonly nodes in a channel will take incoming transactions
+consensus protocol. Gateway nodes in a channel will take incoming transactions
 from clients and submit them to a consensus node to have the transaction ordered
 and executed. The consensus may batch a number of transactions in a single
 request round to reduce the number of consensus messages that are needed to
@@ -45,7 +45,7 @@ There are currently 3 types of nodes:
 
 - [Standalone](#Standalone-Node) nodes are useful for development, but do not connect
 to the distributed network of consensus nodes.
-- [Readonly](#Readonly-Node) nodes provide users with access to the blockchain through
+- [Gateway](#Geadonly-Node) nodes provide users with access to the blockchain through
 RPCs but do not participate in consensus.
 - [Consensus](#Consensus-Node) nodes participate in a channel's consensus to facilitate
 ordering and execution of transactions.
@@ -56,18 +56,18 @@ A standalone node can be used as a development environment for Mazzaroth.
 It provides a way to deploy and interact with a smart contract without
 needing a network of nodes.
 
-### Readonly Node
+### Gateway Node
 
-A readonly node is connected to the network but does not participate in consensus.
-The main role of a readonly node is to allow clients to send requests to the channel
+A gateway node is connected to the network but does not participate in consensus.
+The main role of a gateway node is to allow clients to send requests to the channel
 including submitting transactions and requesting information from the ledger or state.
 
 ### Consensus Node
 
 A consensus node is connected to the network and participates in
 the consensus that accepts transactions into the channel.
 A consensus node does not allow requests from clients,
-but does receive forwarded transactions from other readonly nodes in the network.
+but does receive forwarded transactions from other gateway nodes in the network.
 
 ## Peer to Peer
 
@@ -88,9 +88,9 @@ of the network in order to join.
 
 ### Distributed Ledger
 
-Each type of node (readonly or consensus) will keep a record of transactions
+Each type of node (gateway or consensus) will keep a record of transactions
 that have been executed along with receipts in its Ledger.
-Consensus and Readonly nodes communicate to each other using a p2p protocol
+Consensus and Gateway nodes communicate to each other using a p2p protocol
 backed by the membership to make sure transactions are propagated to all nodes
 in the network. With Consensus ordering we ensure that the ledger of each node
 participating in the network will match for a given height.