From e966eb1455e1890b00eb47f3ac0e42cb569e8707 Mon Sep 17 00:00:00 2001 From: Kelvin Fichter Date: Fri, 17 May 2019 14:24:14 -0400 Subject: [PATCH] Fixed index.rst --- packages/docs/src/spec/index.rst | 43 +++++++++++-------- .../src/spec/src/03-client/checkpoints.rst | 4 ++ .../src/spec/src/03-client/introduction.rst | 4 ++ ...icate-plugins.rst => predicate-plugin.rst} | 6 +-- ...{expressions.rst => query-expressions.rst} | 6 +-- .../{account-db.rst => wallet-db.rst} | 8 ++-- .../src/spec/src/04-operator/introduction | 4 ++ 7 files changed, 47 insertions(+), 28 deletions(-) create mode 100644 packages/docs/src/spec/src/03-client/checkpoints.rst create mode 100644 packages/docs/src/spec/src/03-client/introduction.rst rename packages/docs/src/spec/src/03-client/{predicate-plugins.rst => predicate-plugin.rst} (99%) rename packages/docs/src/spec/src/03-client/{expressions.rst => query-expressions.rst} (98%) rename packages/docs/src/spec/src/03-client/{account-db.rst => wallet-db.rst} (90%) create mode 100644 packages/docs/src/spec/src/04-operator/introduction diff --git a/packages/docs/src/spec/index.rst b/packages/docs/src/spec/index.rst index 477381c5..3ddae4e8 100644 --- a/packages/docs/src/spec/index.rst +++ b/packages/docs/src/spec/index.rst @@ -10,47 +10,54 @@ This website documents the entirety of the Plasma Group design, from the inner w :caption: #00: Introduction src/00-introduction/introduction - src/00-introduciton/plasma - src/00-introduction/plasma-cashflow + src/00-introduciton/operator .. toctree:: :maxdepth: 2 :caption: #01: Core Design Components + src/01-core/state-system src/01-core/coin-ranges src/01-core/merkle-interval-tree - src/01-core/state-system + src/01-core/double-layer-tree + src/01-core/json-rpc .. toctree:: :maxdepth: 2 :caption: #02: Contract Specification - src/02-contracts/deposit - src/02-contracts/commitment - src/02-contracts/predicate + src/02-contracts/deposit-contract + src/02-contracts/commitment-contract + src/02-contracts/predicate-contract .. toctree:: :maxdepth: 2 :caption: #03: Client Specification + src/03-client/introduction src/03-client/architecture src/03-client/deposit-generation - src/03-client/transaction-generation - src/03-client/query-generation src/03-client/event-handling - src/03-client/predicate-plugins + src/03-client/state-queries + src/03-client/transaction-generation + src/03-client/history-proof + src/03-client/history-generation + src/03-client/history-verification + src/03-client/exit-guarding src/03-client/range-db - src/03-client/state-db - src/03-client/history-db - src/03-client/account-db - src/03-client/sync-db + src/03-client/event-watcher + src/03-client/wallet-db src/03-client/wallet - src/03-client/state-manager + src/03-client/predicate-plugin + src/03-client/history-db src/03-client/history-manager - src/03-client/event-watcher + src/03-client/state-db + src/03-client/state-manager + src/03-client/query-expressions + src/03-client/rpc-client src/03-client/rpc-server src/03-client/rpc-methods - + .. toctree:: :maxdepth: 2 :caption: #04: Operator Specification @@ -60,7 +67,7 @@ This website documents the entirety of the Plasma Group design, from the inner w src/04-operator/transaction-ingestion src/04-operator/block-generation src/04-operator/block-db + src/04-operator/block-manager src/04-operator/operator-state-manager - src/04-operator/operator-block-manager - src/04-operator/rpc-methods + src/04-operator/operator-rpc-methods diff --git a/packages/docs/src/spec/src/03-client/checkpoints.rst b/packages/docs/src/spec/src/03-client/checkpoints.rst new file mode 100644 index 00000000..dcf2d708 --- /dev/null +++ b/packages/docs/src/spec/src/03-client/checkpoints.rst @@ -0,0 +1,4 @@ +########### +Checkpoints +########### + diff --git a/packages/docs/src/spec/src/03-client/introduction.rst b/packages/docs/src/spec/src/03-client/introduction.rst new file mode 100644 index 00000000..f39607f5 --- /dev/null +++ b/packages/docs/src/spec/src/03-client/introduction.rst @@ -0,0 +1,4 @@ +############ +Introduction +############ + diff --git a/packages/docs/src/spec/src/03-client/predicate-plugins.rst b/packages/docs/src/spec/src/03-client/predicate-plugin.rst similarity index 99% rename from packages/docs/src/spec/src/03-client/predicate-plugins.rst rename to packages/docs/src/spec/src/03-client/predicate-plugin.rst index feaa9afb..102ecc0f 100644 --- a/packages/docs/src/spec/src/03-client/predicate-plugins.rst +++ b/packages/docs/src/spec/src/03-client/predicate-plugin.rst @@ -1,6 +1,6 @@ -################# -Predicate Plugins -################# +############### +PredicatePlugin +############### *********** Description diff --git a/packages/docs/src/spec/src/03-client/expressions.rst b/packages/docs/src/spec/src/03-client/query-expressions.rst similarity index 98% rename from packages/docs/src/spec/src/03-client/expressions.rst rename to packages/docs/src/spec/src/03-client/query-expressions.rst index 8c69f452..3ffe7c14 100644 --- a/packages/docs/src/spec/src/03-client/expressions.rst +++ b/packages/docs/src/spec/src/03-client/query-expressions.rst @@ -1,6 +1,6 @@ -########### -Expressions -########### +################# +Query Expressions +################# *********** Description diff --git a/packages/docs/src/spec/src/03-client/account-db.rst b/packages/docs/src/spec/src/03-client/wallet-db.rst similarity index 90% rename from packages/docs/src/spec/src/03-client/account-db.rst rename to packages/docs/src/spec/src/03-client/wallet-db.rst index 21a11289..ceafbb55 100644 --- a/packages/docs/src/spec/src/03-client/account-db.rst +++ b/packages/docs/src/spec/src/03-client/wallet-db.rst @@ -1,11 +1,11 @@ -######### -AccountDB -######### +######## +WalletDB +######## *********** Description *********** -``AccountDB`` stores and manages access to `standard keystore`_ files. We require that keystore files **MUST** be encrypted for the safety of user funds. +``WalletDB`` stores and manages access to `standard keystore`_ files. We require that keystore files **MUST** be encrypted for the safety of user funds. *************** Data Structures diff --git a/packages/docs/src/spec/src/04-operator/introduction b/packages/docs/src/spec/src/04-operator/introduction new file mode 100644 index 00000000..f39607f5 --- /dev/null +++ b/packages/docs/src/spec/src/04-operator/introduction @@ -0,0 +1,4 @@ +############ +Introduction +############ +