From ccf17430753c1b0059c8e43883a92a97781c7a2b Mon Sep 17 00:00:00 2001 From: olegfomenko2002 Date: Thu, 26 Oct 2023 15:22:32 +0300 Subject: [PATCH] fixed docs: adding index md file --- docs/common/bridging/001-bridging.md | 5 ++++ docs/common/bridging/002-identity.md | 5 ++++ docs/common/bridging/003-rarimo-identity.md | 5 ++++ docs/common/contracts/001-contracts.md | 5 ++++ docs/common/contracts/002-bridge.md | 5 ++++ docs/common/contracts/003-commission.md | 5 ++++ docs/common/core/001-adding-operation.md | 5 ++++ docs/common/core/002-creating-genesis.md | 5 ++++ docs/common/mainnet/001-mainnet.md | 5 ++++ docs/common/mainnet/002-upgrades.md | 5 ++++ docs/common/mainnet/003-validator-guide.md | 5 ++++ docs/common/oracles/001-oracles.md | 5 ++++ .../oracles/002-running-identity-oracle.md | 7 ++++- docs/common/testnet/001-testnet.md | 7 ++++- docs/common/testnet/002-validator-guide.md | 5 ++++ index.md | 28 +++++++++++++++++++ x/README.md | 5 ++++ x/bridge/README.md | 4 +++ x/evm/README.md | 5 ++++ x/identity/README.md | 5 ++++ x/multisig/README.md | 5 ++++ x/oraclemanager/README.md | 5 ++++ x/rarimocore/README.md | 5 ++++ x/tokenmanager/README.md | 5 ++++ x/vestingmint/README.md | 5 ++++ 25 files changed, 149 insertions(+), 2 deletions(-) create mode 100644 index.md diff --git a/docs/common/bridging/001-bridging.md b/docs/common/bridging/001-bridging.md index 14799f76..fab4a03b 100644 --- a/docs/common/bridging/001-bridging.md +++ b/docs/common/bridging/001-bridging.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Bridging +--- + # Bridging Bridging documentation describes current existing implementations over our cross-chain messaging protocol. diff --git a/docs/common/bridging/002-identity.md b/docs/common/bridging/002-identity.md index c16281f8..e2a7e857 100644 --- a/docs/common/bridging/002-identity.md +++ b/docs/common/bridging/002-identity.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Identity transfers +--- + # Identity transfers Identity transfers currently implemented in the following way: diff --git a/docs/common/bridging/003-rarimo-identity.md b/docs/common/bridging/003-rarimo-identity.md index f95e2561..e26dc430 100644 --- a/docs/common/bridging/003-rarimo-identity.md +++ b/docs/common/bridging/003-rarimo-identity.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Rarimo Identity +--- + # Rarimo Identity Rarimo identity transfers provides issuers with opportunity to publish cheap state updates into Rarimo chain directly, diff --git a/docs/common/contracts/001-contracts.md b/docs/common/contracts/001-contracts.md index f381cb2c..ab198593 100644 --- a/docs/common/contracts/001-contracts.md +++ b/docs/common/contracts/001-contracts.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Smart-contracts overview +--- + # Smart-contracts overview Rarimo smart-contracts are the primary way to interact with our multi-chain protocol. diff --git a/docs/common/contracts/002-bridge.md b/docs/common/contracts/002-bridge.md index dfe57885..5e9cc1b0 100644 --- a/docs/common/contracts/002-bridge.md +++ b/docs/common/contracts/002-bridge.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Bridge overview +--- + # Bridge overview Rarimo decentralized bridge contract is responsible for managing deposits and withdrawals for Native, fungible and non-fungible tokens. All withdrawal operations are protected by ECDSA secp256k1 threshold (t-n) signature. diff --git a/docs/common/contracts/003-commission.md b/docs/common/contracts/003-commission.md index a289a9af..49706188 100644 --- a/docs/common/contracts/003-commission.md +++ b/docs/common/contracts/003-commission.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Commission overview +--- + # Commission overview The bridge feature is the main component of Rarimo cross-chain messaging protocol. diff --git a/docs/common/core/001-adding-operation.md b/docs/common/core/001-adding-operation.md index ea66a96b..a1c853c4 100644 --- a/docs/common/core/001-adding-operation.md +++ b/docs/common/core/001-adding-operation.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Adding new operation +--- + # Adding new operation To provide TSS signature core uses operations and confirmation entities. diff --git a/docs/common/core/002-creating-genesis.md b/docs/common/core/002-creating-genesis.md index 8b7534bd..dd6b9542 100644 --- a/docs/common/core/002-creating-genesis.md +++ b/docs/common/core/002-creating-genesis.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Setup local genesis state +--- + # Setup local genesis state ### Creating validator key diff --git a/docs/common/mainnet/001-mainnet.md b/docs/common/mainnet/001-mainnet.md index af7ca112..49a6b851 100644 --- a/docs/common/mainnet/001-mainnet.md +++ b/docs/common/mainnet/001-mainnet.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Mainnet information +--- + # Mainnet information * [Upgrades](./002-upgrades.md) diff --git a/docs/common/mainnet/002-upgrades.md b/docs/common/mainnet/002-upgrades.md index e83cbec0..3f56fe3a 100644 --- a/docs/common/mainnet/002-upgrades.md +++ b/docs/common/mainnet/002-upgrades.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Mainnet upgrades +--- + # Mainnet upgrades ## V1.0.7 diff --git a/docs/common/mainnet/003-validator-guide.md b/docs/common/mainnet/003-validator-guide.md index 78264f47..c4ccef51 100644 --- a/docs/common/mainnet/003-validator-guide.md +++ b/docs/common/mainnet/003-validator-guide.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Validators' Guide +--- + # Validators' Guide This instruction tells how to start one or another system service. diff --git a/docs/common/oracles/001-oracles.md b/docs/common/oracles/001-oracles.md index 47fb3e29..b141911d 100644 --- a/docs/common/oracles/001-oracles.md +++ b/docs/common/oracles/001-oracles.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Oracles (Savers) +--- + # Oracles (Savers) - Repo: [Saver Lib](https://github.com/rarimo/saver-grpc-lib) diff --git a/docs/common/oracles/002-running-identity-oracle.md b/docs/common/oracles/002-running-identity-oracle.md index fb7d424c..c94d0350 100644 --- a/docs/common/oracles/002-running-identity-oracle.md +++ b/docs/common/oracles/002-running-identity-oracle.md @@ -1,9 +1,14 @@ +--- +layout: default +title: Running saver (oracle) service +--- + # Running saver (oracle) service ## Broadcaster service The broadcaster service should be the only one entrypoint for submitting transactions from certain rarimo account. -All your oracle services that uses the same account should submit transaction though the same roadcaster service. +All your oracle services that uses the same account should submit transaction though the same broadcaster service. To start `broadcaster-svc` service you need a hex private key that will be used to sign messages. diff --git a/docs/common/testnet/001-testnet.md b/docs/common/testnet/001-testnet.md index 74a2ea2b..8491bd3a 100644 --- a/docs/common/testnet/001-testnet.md +++ b/docs/common/testnet/001-testnet.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Testnet information +--- + # Testnet information * [Validator Guide](./002-validator-guide.md) @@ -10,7 +15,7 @@ ```Explorer:``` [scan.mainnet-beta.rarimo.com](https://scan.mainnet-beta.rarimo.com/) -```Denom name:``` ***urmo*** +```Denom name:``` ***stake*** ---- diff --git a/docs/common/testnet/002-validator-guide.md b/docs/common/testnet/002-validator-guide.md index 8c17a4bc..81379793 100644 --- a/docs/common/testnet/002-validator-guide.md +++ b/docs/common/testnet/002-validator-guide.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Validators' Guide +--- + # Validators' Guide This instruction tells how to start one or another system service. diff --git a/index.md b/index.md new file mode 100644 index 00000000..492a5773 --- /dev/null +++ b/index.md @@ -0,0 +1,28 @@ +--- +layout: default +title: Rarimo Developer Documentation +--- + +# Rarimo Developer Documentation + +## Introduction + +**rarimo-core** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli). + +Based on Tendermint + Cosmos SDK blockchain core the main goal is to provide validated information about different cross-chain operations. + +## Documentation + +### 1. :open_file_folder: [Core Modules](./x/README.md) + +### 2. :telescope: [Oracles Overview](./docs/common/oracles/001-oracles.md) + +### 3. :chart_with_upwards_trend: [Bridge Contracts](./docs/common/contracts/001-contracts.md) + +### 4. :rocket: [Bridging Overview](./docs/common/bridging/001-bridging.md) + +## Chains + +### 1. :earth_americas: [Mainnet information](./docs/common/mainnet/001-mainnet.md) + +### 2. :globe_with_meridians: [Testnet (Mainnet-beta) information](./docs/common/testnet/001-testnet.md) \ No newline at end of file diff --git a/x/README.md b/x/README.md index e521c925..69e383a4 100644 --- a/x/README.md +++ b/x/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: List of Modules +--- + # List of Modules * [x/rarimocore](./rarimocore/README.md) - Base transfer logic (signing, storing operations, tss parties staking). diff --git a/x/bridge/README.md b/x/bridge/README.md index 971526d2..d16c2c89 100644 --- a/x/bridge/README.md +++ b/x/bridge/README.md @@ -1,3 +1,7 @@ +--- +layout: default +title: x/bridge +--- # `x/bridge` diff --git a/x/evm/README.md b/x/evm/README.md index 099b6c61..02ef8fc2 100644 --- a/x/evm/README.md +++ b/x/evm/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/evm +--- + # `x/evm` ## Abstract diff --git a/x/identity/README.md b/x/identity/README.md index 72b39e63..dee116c5 100644 --- a/x/identity/README.md +++ b/x/identity/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/identity +--- + # `x/identity` ## Abstract diff --git a/x/multisig/README.md b/x/multisig/README.md index 1887b497..0430389e 100644 --- a/x/multisig/README.md +++ b/x/multisig/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/multisig +--- + # `x/multisig` ## Abstract diff --git a/x/oraclemanager/README.md b/x/oraclemanager/README.md index 293bd06e..40b5a10d 100644 --- a/x/oraclemanager/README.md +++ b/x/oraclemanager/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/oraclemanager +--- + # `x/oraclemanager` ## Abstract diff --git a/x/rarimocore/README.md b/x/rarimocore/README.md index 700f6d09..586a0a2c 100644 --- a/x/rarimocore/README.md +++ b/x/rarimocore/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/rarimocore +--- + # `x/rarimocore` ## Abstract diff --git a/x/tokenmanager/README.md b/x/tokenmanager/README.md index 0cfad7b8..8920e3be 100644 --- a/x/tokenmanager/README.md +++ b/x/tokenmanager/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/tokenamanager +--- + # `x/tokenamanager` ## Abstract diff --git a/x/vestingmint/README.md b/x/vestingmint/README.md index 98b989e7..a52395c5 100644 --- a/x/vestingmint/README.md +++ b/x/vestingmint/README.md @@ -1,3 +1,8 @@ +--- +layout: default +title: x/vestingmint +--- + # `x/vestingmint` ## Abstract