move docs, include sequence doc, add gitignore

0xPolygon · Dec 4, 2023 · 1382eb6 · 1382eb6
1 parent 48d78df
commit 1382eb6
Show file tree

Hide file tree

Showing 97 changed files with 10 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,3 +31,12 @@ node_modules
 
 vendor/
 coverage.out
+
+# for the docs folder
+.code
+docs/site/
+docs/venv/
+docs/env/
+*.out
+node_modules/
+*.iml
diff --git a/wiki-docs/Dockerfile → docs/Dockerfile b/wiki-docs/Dockerfile → docs/Dockerfile
diff --git a/wiki-docs/README.md → docs/README.md b/wiki-docs/README.md → docs/README.md
diff --git a/wiki-docs/docker-compose.yml → docs/docker-compose.yml b/wiki-docs/docker-compose.yml → docs/docker-compose.yml
diff --git a/wiki-docs/docs/api/json-rpc-bridge.md → docs/docs/api/json-rpc-bridge.md b/wiki-docs/docs/api/json-rpc-bridge.md → docs/docs/api/json-rpc-bridge.md
diff --git a/wiki-docs/docs/api/json-rpc-debug.md → docs/docs/api/json-rpc-debug.md b/wiki-docs/docs/api/json-rpc-debug.md → docs/docs/api/json-rpc-debug.md
diff --git a/wiki-docs/docs/api/json-rpc-eth.md → docs/docs/api/json-rpc-eth.md b/wiki-docs/docs/api/json-rpc-eth.md → docs/docs/api/json-rpc-eth.md
diff --git a/wiki-docs/docs/api/json-rpc-net.md → docs/docs/api/json-rpc-net.md b/wiki-docs/docs/api/json-rpc-net.md → docs/docs/api/json-rpc-net.md
diff --git a/wiki-docs/docs/api/json-rpc-txpool.md → docs/docs/api/json-rpc-txpool.md b/wiki-docs/docs/api/json-rpc-txpool.md → docs/docs/api/json-rpc-txpool.md
diff --git a/wiki-docs/docs/api/json-rpc-web3.md → docs/docs/api/json-rpc-web3.md b/wiki-docs/docs/api/json-rpc-web3.md → docs/docs/api/json-rpc-web3.md
diff --git a/wiki-docs/docs/design/blockchain.md → docs/docs/design/blockchain.md b/wiki-docs/docs/design/blockchain.md → docs/docs/design/blockchain.md
diff --git a/.../docs/design/bridge/assets/erc/erc1155.md → .../docs/design/bridge/assets/erc/erc1155.md b/.../docs/design/bridge/assets/erc/erc1155.md → .../docs/design/bridge/assets/erc/erc1155.md
diff --git a/...cs/docs/design/bridge/assets/erc/erc20.md → docs/docs/design/bridge/assets/erc/erc20.md b/...cs/docs/design/bridge/assets/erc/erc20.md → docs/docs/design/bridge/assets/erc/erc20.md
diff --git a/...s/docs/design/bridge/assets/erc/erc721.md → docs/docs/design/bridge/assets/erc/erc721.md b/...s/docs/design/bridge/assets/erc/erc721.md → docs/docs/design/bridge/assets/erc/erc721.md
diff --git a/wiki-docs/docs/design/bridge/checkpoint.md → docs/docs/design/bridge/checkpoint.md b/wiki-docs/docs/design/bridge/checkpoint.md → docs/docs/design/bridge/checkpoint.md
diff --git a/wiki-docs/docs/design/bridge/overview.md → docs/docs/design/bridge/overview.md b/wiki-docs/docs/design/bridge/overview.md → docs/docs/design/bridge/overview.md
diff --git a/docs/bridge/sequences.md → docs/docs/design/bridge/sequences.md b/docs/bridge/sequences.md → docs/docs/design/bridge/sequences.md
diff --git a/wiki-docs/docs/design/bridge/statesync.md → docs/docs/design/bridge/statesync.md b/wiki-docs/docs/design/bridge/statesync.md → docs/docs/design/bridge/statesync.md
diff --git a/...ocs/docs/design/consensus/polybft/ibft.md → docs/docs/design/consensus/polybft/ibft.md b/...ocs/docs/design/consensus/polybft/ibft.md → docs/docs/design/consensus/polybft/ibft.md
diff --git a/...docs/design/consensus/polybft/overview.md → ...docs/design/consensus/polybft/overview.md b/...docs/design/consensus/polybft/overview.md → ...docs/design/consensus/polybft/overview.md
diff --git a/...docs/design/consensus/polybft/protocol.md → ...docs/design/consensus/polybft/protocol.md b/...docs/design/consensus/polybft/protocol.md → ...docs/design/consensus/polybft/protocol.md
diff --git a/wiki-docs/docs/design/grpc.md → docs/docs/design/grpc.md b/wiki-docs/docs/design/grpc.md → docs/docs/design/grpc.md
diff --git a/wiki-docs/docs/design/jsonrpc.md → docs/docs/design/jsonrpc.md b/wiki-docs/docs/design/jsonrpc.md → docs/docs/design/jsonrpc.md
diff --git a/wiki-docs/docs/design/libp2p.md → docs/docs/design/libp2p.md b/wiki-docs/docs/design/libp2p.md → docs/docs/design/libp2p.md
diff --git a/wiki-docs/docs/design/mempool.md → docs/docs/design/mempool.md b/wiki-docs/docs/design/mempool.md → docs/docs/design/mempool.md
diff --git a/wiki-docs/docs/design/overview.md → docs/docs/design/overview.md b/wiki-docs/docs/design/overview.md → docs/docs/design/overview.md
diff --git a/wiki-docs/docs/design/runtime/allowlist.md → docs/docs/design/runtime/allowlist.md b/wiki-docs/docs/design/runtime/allowlist.md → docs/docs/design/runtime/allowlist.md
diff --git a/wiki-docs/docs/design/runtime/overview.md → docs/docs/design/runtime/overview.md b/wiki-docs/docs/design/runtime/overview.md → docs/docs/design/runtime/overview.md
diff --git a/wiki-docs/docs/design/txpool.md → docs/docs/design/txpool.md b/wiki-docs/docs/design/txpool.md → docs/docs/design/txpool.md
diff --git a/wiki-docs/docs/design/txrelayer.md → docs/docs/design/txrelayer.md b/wiki-docs/docs/design/txrelayer.md → docs/docs/design/txrelayer.md
diff --git a/wiki-docs/docs/disclaimer.md → docs/docs/disclaimer.md b/wiki-docs/docs/disclaimer.md → docs/docs/disclaimer.md
diff --git a/.../bridge-deposit-childchain.excalidraw.png → .../bridge-deposit-childchain.excalidraw.png b/.../bridge-deposit-childchain.excalidraw.png → .../bridge-deposit-childchain.excalidraw.png
diff --git a/...e/bridge-deposit-rootchain.excalidraw.png → ...e/bridge-deposit-rootchain.excalidraw.png b/...e/bridge-deposit-rootchain.excalidraw.png → ...e/bridge-deposit-rootchain.excalidraw.png
diff --git a/...bridge-withdraw-childchain.excalidraw.png → ...bridge-withdraw-childchain.excalidraw.png b/...bridge-withdraw-childchain.excalidraw.png → ...bridge-withdraw-childchain.excalidraw.png
diff --git a/.../bridge-withdraw-rootchain.excalidraw.png → .../bridge-withdraw-rootchain.excalidraw.png b/.../bridge-withdraw-rootchain.excalidraw.png → .../bridge-withdraw-rootchain.excalidraw.png
diff --git a/...cs/docs/img/edge/consensus.excalidraw.png → docs/docs/img/edge/consensus.excalidraw.png b/...cs/docs/img/edge/consensus.excalidraw.png → docs/docs/img/edge/consensus.excalidraw.png
diff --git a/.../img/edge/contracts-bridge.excalidraw.png → .../img/edge/contracts-bridge.excalidraw.png b/.../img/edge/contracts-bridge.excalidraw.png → .../img/edge/contracts-bridge.excalidraw.png
diff --git a/...cs/docs/img/edge/contracts.excalidraw.png → docs/docs/img/edge/contracts.excalidraw.png b/...cs/docs/img/edge/contracts.excalidraw.png → docs/docs/img/edge/contracts.excalidraw.png
diff --git a/...ocs/docs/img/edge/l1-l2-l3.excalidraw.png → docs/docs/img/edge/l1-l2-l3.excalidraw.png b/...ocs/docs/img/edge/l1-l2-l3.excalidraw.png → docs/docs/img/edge/l1-l2-l3.excalidraw.png
diff --git a/...docs/img/edge/polybft-node.excalidraw.png → ...docs/img/edge/polybft-node.excalidraw.png b/...docs/img/edge/polybft-node.excalidraw.png → ...docs/img/edge/polybft-node.excalidraw.png
diff --git a/...docs/docs/img/edge/polybft.excalidraw.png → docs/docs/img/edge/polybft.excalidraw.png b/...docs/docs/img/edge/polybft.excalidraw.png → docs/docs/img/edge/polybft.excalidraw.png
diff --git a/wiki-docs/docs/img/edge/supernet.svg → docs/docs/img/edge/supernet.svg b/wiki-docs/docs/img/edge/supernet.svg → docs/docs/img/edge/supernet.svg
diff --git a/.../supernets-checkpoint-exit.excalidraw.png → .../supernets-checkpoint-exit.excalidraw.png b/.../supernets-checkpoint-exit.excalidraw.png → .../supernets-checkpoint-exit.excalidraw.png
diff --git a/.../edge/supernets-checkpoint.excalidraw.png → .../edge/supernets-checkpoint.excalidraw.png b/.../edge/supernets-checkpoint.excalidraw.png → .../edge/supernets-checkpoint.excalidraw.png
diff --git a/...g/edge/supernets-consensus.excalidraw.png → ...g/edge/supernets-consensus.excalidraw.png b/...g/edge/supernets-consensus.excalidraw.png → ...g/edge/supernets-consensus.excalidraw.png
diff --git a/...e/supernets-interconnected.excalidraw.png → ...e/supernets-interconnected.excalidraw.png b/...e/supernets-interconnected.excalidraw.png → ...e/supernets-interconnected.excalidraw.png
diff --git a/wiki-docs/docs/img/edge/supernets-logo.png → docs/docs/img/edge/supernets-logo.png b/wiki-docs/docs/img/edge/supernets-logo.png → docs/docs/img/edge/supernets-logo.png
diff --git a/...mg/edge/supernets-overview.excalidraw.png → ...mg/edge/supernets-overview.excalidraw.png b/...mg/edge/supernets-overview.excalidraw.png → ...mg/edge/supernets-overview.excalidraw.png
diff --git a/...g/edge/supernets-setup-non.excalidraw.png → ...g/edge/supernets-setup-non.excalidraw.png b/...g/edge/supernets-setup-non.excalidraw.png → ...g/edge/supernets-setup-non.excalidraw.png
diff --git a/...s/img/edge/supernets-setup.excalidraw.png → ...s/img/edge/supernets-setup.excalidraw.png b/...s/img/edge/supernets-setup.excalidraw.png → ...s/img/edge/supernets-setup.excalidraw.png
diff --git a/...edge/supernets-together-lp.excalidraw.png → ...edge/supernets-together-lp.excalidraw.png b/...edge/supernets-together-lp.excalidraw.png → ...edge/supernets-together-lp.excalidraw.png
diff --git a/...mg/edge/supernets-together.excalidraw.png → ...mg/edge/supernets-together.excalidraw.png b/...mg/edge/supernets-together.excalidraw.png → ...mg/edge/supernets-together.excalidraw.png
diff --git a/...s/docs/img/edge/val-select.excalidraw.png → docs/docs/img/edge/val-select.excalidraw.png b/...s/docs/img/edge/val-select.excalidraw.png → docs/docs/img/edge/val-select.excalidraw.png
diff --git a/wiki-docs/docs/index.md → docs/docs/index.md b/wiki-docs/docs/index.md → docs/docs/index.md
diff --git a/...-docs/docs/interfaces/cryptography/bls.md → docs/docs/interfaces/cryptography/bls.md b/...-docs/docs/interfaces/cryptography/bls.md → docs/docs/interfaces/cryptography/bls.md
diff --git a/...s/docs/interfaces/cryptography/bn256g2.md → docs/docs/interfaces/cryptography/bn256g2.md b/...s/docs/interfaces/cryptography/bn256g2.md → docs/docs/interfaces/cryptography/bn256g2.md
diff --git a/wiki-docs/docs/interfaces/eip1559.md → docs/docs/interfaces/eip1559.md b/wiki-docs/docs/interfaces/eip1559.md → docs/docs/interfaces/eip1559.md
diff --git a/...erfaces/erc1155/childerc1155-predicate.md → ...erfaces/erc1155/childerc1155-predicate.md b/...erfaces/erc1155/childerc1155-predicate.md → ...erfaces/erc1155/childerc1155-predicate.md
diff --git a/...s/docs/interfaces/erc1155/childerc1155.md → docs/docs/interfaces/erc1155/childerc1155.md b/...s/docs/interfaces/erc1155/childerc1155.md → docs/docs/interfaces/erc1155/childerc1155.md
diff --git a/...terfaces/erc1155/rooterc1155-predicate.md → ...terfaces/erc1155/rooterc1155-predicate.md b/...terfaces/erc1155/rooterc1155-predicate.md → ...terfaces/erc1155/rooterc1155-predicate.md
diff --git a/.../interfaces/erc20/childerc20-predicate.md → .../interfaces/erc20/childerc20-predicate.md b/.../interfaces/erc20/childerc20-predicate.md → .../interfaces/erc20/childerc20-predicate.md
diff --git a/...-docs/docs/interfaces/erc20/childerc20.md → docs/docs/interfaces/erc20/childerc20.md b/...-docs/docs/interfaces/erc20/childerc20.md → docs/docs/interfaces/erc20/childerc20.md
diff --git a/...ocs/docs/interfaces/erc20/native-erc20.md → docs/docs/interfaces/erc20/native-erc20.md b/...ocs/docs/interfaces/erc20/native-erc20.md → docs/docs/interfaces/erc20/native-erc20.md
diff --git a/...s/interfaces/erc20/rooterc20-predicate.md → ...s/interfaces/erc20/rooterc20-predicate.md b/...s/interfaces/erc20/rooterc20-predicate.md → ...s/interfaces/erc20/rooterc20-predicate.md
diff --git a/...nterfaces/erc721/childerc721-predicate.md → ...nterfaces/erc721/childerc721-predicate.md b/...nterfaces/erc721/childerc721-predicate.md → ...nterfaces/erc721/childerc721-predicate.md
diff --git a/...ocs/docs/interfaces/erc721/childerc721.md → docs/docs/interfaces/erc721/childerc721.md b/...ocs/docs/interfaces/erc721/childerc721.md → docs/docs/interfaces/erc721/childerc721.md
diff --git a/...interfaces/erc721/rooterc721-predicate.md → ...interfaces/erc721/rooterc721-predicate.md b/...interfaces/erc721/rooterc721-predicate.md → ...interfaces/erc721/rooterc721-predicate.md
diff --git a/.../interfaces/network/checkpoint-manager.md → .../interfaces/network/checkpoint-manager.md b/.../interfaces/network/checkpoint-manager.md → .../interfaces/network/checkpoint-manager.md
diff --git a/...cs/docs/interfaces/network/exit-helper.md → docs/docs/interfaces/network/exit-helper.md b/...cs/docs/interfaces/network/exit-helper.md → docs/docs/interfaces/network/exit-helper.md
diff --git a/...docs/interfaces/network/state-receiver.md → ...docs/interfaces/network/state-receiver.md b/...docs/interfaces/network/state-receiver.md → ...docs/interfaces/network/state-receiver.md
diff --git a/...s/docs/interfaces/network/state-sender.md → docs/docs/interfaces/network/state-sender.md b/...s/docs/interfaces/network/state-sender.md → docs/docs/interfaces/network/state-sender.md
diff --git a/...rfaces/staking/custom-supernet-manager.md → ...rfaces/staking/custom-supernet-manager.md b/...rfaces/staking/custom-supernet-manager.md → ...rfaces/staking/custom-supernet-manager.md
diff --git a/.../docs/interfaces/staking/stake-manager.md → .../docs/interfaces/staking/stake-manager.md b/.../docs/interfaces/staking/stake-manager.md → .../docs/interfaces/staking/stake-manager.md
diff --git a/...cs/interfaces/staking/supernet-manager.md → ...cs/interfaces/staking/supernet-manager.md b/...cs/interfaces/staking/supernet-manager.md → ...cs/interfaces/staking/supernet-manager.md
diff --git a/...terfaces/validators/validator-set-base.md → ...terfaces/validators/validator-set-base.md b/...terfaces/validators/validator-set-base.md → ...terfaces/validators/validator-set-base.md
diff --git a/wiki-docs/docs/operate/benchmarks.md → docs/docs/operate/benchmarks.md b/wiki-docs/docs/operate/benchmarks.md → docs/docs/operate/benchmarks.md
diff --git a/...eploy/access-control/allowlist-general.md → ...eploy/access-control/allowlist-general.md b/...eploy/access-control/allowlist-general.md → ...eploy/access-control/allowlist-general.md
diff --git a/...docs/operate/deploy/genesis-validators.md → ...docs/operate/deploy/genesis-validators.md b/...docs/operate/deploy/genesis-validators.md → ...docs/operate/deploy/genesis-validators.md
diff --git a/wiki-docs/docs/operate/deploy/genesis.md → docs/docs/operate/deploy/genesis.md b/wiki-docs/docs/operate/deploy/genesis.md → docs/docs/operate/deploy/genesis.md
diff --git a/wiki-docs/docs/operate/deploy/index.md → docs/docs/operate/deploy/index.md b/wiki-docs/docs/operate/deploy/index.md → docs/docs/operate/deploy/index.md
diff --git a/wiki-docs/docs/operate/deploy/local-chain.md → docs/docs/operate/deploy/local-chain.md b/wiki-docs/docs/operate/deploy/local-chain.md → docs/docs/operate/deploy/local-chain.md
diff --git a/...s/docs/operate/deploy/rootchain-config.md → docs/docs/operate/deploy/rootchain-config.md b/...s/docs/operate/deploy/rootchain-config.md → docs/docs/operate/deploy/rootchain-config.md
diff --git a/...docs/docs/operate/deploy/staking/stake.md → docs/docs/operate/deploy/staking/stake.md b/...docs/docs/operate/deploy/staking/stake.md → docs/docs/operate/deploy/staking/stake.md
diff --git a/...cs/docs/operate/deploy/staking/unstake.md → docs/docs/operate/deploy/staking/unstake.md b/...cs/docs/operate/deploy/staking/unstake.md → docs/docs/operate/deploy/staking/unstake.md
diff --git a/wiki-docs/docs/operate/deploy/start-chain.md → docs/docs/operate/deploy/start-chain.md b/wiki-docs/docs/operate/deploy/start-chain.md → docs/docs/operate/deploy/start-chain.md
diff --git a/.../docs/operate/deploy/transfers/deposit.md → .../docs/operate/deploy/transfers/deposit.md b/.../docs/operate/deploy/transfers/deposit.md → .../docs/operate/deploy/transfers/deposit.md
diff --git a/...docs/operate/deploy/transfers/withdraw.md → ...docs/operate/deploy/transfers/withdraw.md b/...docs/operate/deploy/transfers/withdraw.md → ...docs/operate/deploy/transfers/withdraw.md
diff --git a/.../docs/operate/deploy/upgrades/hardfork.md → .../docs/operate/deploy/upgrades/hardfork.md b/.../docs/operate/deploy/upgrades/hardfork.md → .../docs/operate/deploy/upgrades/hardfork.md
diff --git a/...docs/docs/operate/deploy/upgrades/v1.1.md → docs/docs/operate/deploy/upgrades/v1.1.md b/...docs/docs/operate/deploy/upgrades/v1.1.md → docs/docs/operate/deploy/upgrades/v1.1.md
diff --git a/wiki-docs/docs/operate/install.md → docs/docs/operate/install.md b/wiki-docs/docs/operate/install.md → docs/docs/operate/install.md
diff --git a/wiki-docs/docs/operate/param-reference.md → docs/docs/operate/param-reference.md b/wiki-docs/docs/operate/param-reference.md → docs/docs/operate/param-reference.md
diff --git a/wiki-docs/docs/operate/system.md → docs/docs/operate/system.md b/wiki-docs/docs/operate/system.md → docs/docs/operate/system.md
diff --git a/wiki-docs/docs/quickstart.md → docs/docs/quickstart.md b/wiki-docs/docs/quickstart.md → docs/docs/quickstart.md
diff --git a/wiki-docs/mkdocs.yml → docs/mkdocs.yml b/wiki-docs/mkdocs.yml → docs/mkdocs.yml
@@ -22,6 +22,7 @@ nav:
               - ERC-20:  design/bridge/assets/erc/erc20.md
               - ERC-721:  design/bridge/assets/erc/erc721.md
               - ERC-1155:  design/bridge/assets/erc/erc1155.md
+          - Sequences: design/bridge/sequences.md
       - Networking: design/libp2p.md
       - Runtime:
           - Overview:  design/runtime/overview.md

diff --git a/wiki-docs/requirements.txt → docs/requirements.txt b/wiki-docs/requirements.txt → docs/requirements.txt
diff --git a/wiki-docs/run.sh → docs/run.sh b/wiki-docs/run.sh → docs/run.sh
diff --git a/wiki-docs/.gitignore b/wiki-docs/.gitignore