Update documentation structure (#47)

* rm landing

* Tweaked structure

* identity => credential trees

* Base layer -> Rarimo Core

* products/rarime -> rarime

* Passport-derived profiles -> accounts

* Added commitment trees

* Aggregator

* Freedom tool up

* Freedom tool up

* tweaked menu styles

* Unwrap use cases

* tweak menu appearance

* Fixed Rarimo core issue

* Added changelog

CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- Updated the docs structure to reflect the shift to social protocol;
+- Renamed the "Identity Protocol" to "Credential Trees";
+- Restyled the sidebar;
+= Root path leads to the "Overview" doc;
+
+### Removed
+- Landing page;
+- Obsolete use case docs:
+  - "Social graphs";
+  - "Gaming profiles"
+  - "Self-sovereign identity";
+
 ## [3.7.8] - 2024-05-31
 ### Changed
 - Disabled the "search" page for now due to bug in Algolia plugin;

docs/products/passport-derived-profiles/overview.mdx → docs/accounts/overview.mdx

@@ -1,5 +1,5 @@
 ---
-slug: /products/passport-derived-profiles/
+slug: /accounts/
 description: Passport-derived profiles turn biometric passports into zero-knowledge identity credentials for Web3.
 ---
 import OutLink from "@site/src/components/OutLink";

docs/commitment-trees/commitments.mdx

@@ -0,0 +1,9 @@
+---
+slug: /commitment-trees/commitments
+title: Commitments
+description: Commitments
+---
+import OutLink from "@site/src/components/OutLink";
+import IdealImage from '@site/src/components/IdealImage';
+
+# Commitments

docs/commitment-trees/overview.mdx

@@ -0,0 +1,9 @@
+---
+slug: /commitment-trees
+title: Commitment trees
+description: Commitment trees
+---
+import OutLink from "@site/src/components/OutLink";
+import IdealImage from '@site/src/components/IdealImage';
+
+# Commitment trees

docs/commitment-trees/statement-trees.mdx

@@ -0,0 +1,9 @@
+---
+slug: /commitment-trees/statement-trees
+title: Statement trees
+description: Statement trees
+---
+import OutLink from "@site/src/components/OutLink";
+import IdealImage from '@site/src/components/IdealImage';
+
+# Statement trees

docs/commitment-trees/time-trees.mdx

@@ -0,0 +1,9 @@
+---
+slug: /commitment-trees/time-trees
+title: Time trees
+description: Time trees
+---
+import OutLink from "@site/src/components/OutLink";
+import IdealImage from '@site/src/components/IdealImage';
+
+# Time trees

docs/products/identity-protocol/overview.mdx → docs/credential-trees/overview.mdx

@@ -1,12 +1,12 @@
 ---
-slug: /products/identity-protocol
-title: Rarimo Identity Protocol
+slug: /credential-trees
+title: Credential trees
 description:  Self-sovereign digital identity protocol lets users prove their identity on any blockchain. Crytpo identity privacy is protected by zero-knowledge proof technology.
 ---
 import OutLink from "@site/src/components/OutLink";
 import IdealImage from '@site/src/components/IdealImage';
 
-# Rarimo Identity Protocol
+# Credential trees
 
 ## Problem statement
 

docs/ecosystem/proof-of-humanity/overview.mdx

@@ -1,11 +1,11 @@
 ---
 slug: /ecosystem/proof-of-humanity
-description: Proof of Humanity provides robust captcha altervnatives to confirm that accounts are operated by real people.
+description: Proof of Humanity Aggregator provides robust captcha altervnatives to confirm that accounts are operated by real people.
 # TODO: - Add diagrams & screenshots
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# Proof of Humanity
+# Proof of Humanity Aggregator
 
 ## The problem
 

docs/overview.mdx

@@ -1,5 +1,6 @@
 ---
 description: Rarimo is a privacy-first social protocol that seamlessly combines various identity standards and forms a private but verifiable social graph.
+slug: /
 ---
 import OutLink from "@site/src/components/OutLink";
 import IdealImage from '@site/src/components/IdealImage';

docs/products/rarime/guide-for-issuers.mdx → docs/rarime/guide-for-issuers.mdx

@@ -1,5 +1,5 @@
 ---
-slug: /products/rarime/guide-issuing-credentials-to-rarime
+slug: /rarime/guide-issuing-credentials-to-rarime
 title: Issuing credentials to RariMe users
 description: Learn how to use rarime-connector library to offer your credentials to RariMe users.
 ---
@@ -8,7 +8,7 @@ import IdealImage from '@site/src/components/IdealImage';
 # Guide: Issuing credentials to RariMe
 
 :::tip
-If you still need to learn to issue Rarimo credentials, see [Setting Up A Credentials Issuer](/products/identity-protocol/guide-how-to-set-up-credentials-issuer).
+If you still need to learn to issue Rarimo credentials, see [Setting Up A Credentials Issuer](/credential-trees/guide-how-to-set-up-credentials-issuer).
 :::
 
 After issuing Rarimo credentials, you need to serve them to the users. To do that, we'll integrate RariMe snap into your DApp.

docs/products/rarime/interoperability-with-external-credentials.mdx → docs/rarime/interoperability-with-external-credentials.mdx

@@ -1,5 +1,5 @@
 ---
-slug: /products/rarime/interoperability-with-external-credentials
+slug: /rarime/interoperability-with-external-credentials
 description: Existing identity providers and protocols can offer their credentials to RariMe users.
 ---
 import OutLink from '@site/src/components/OutLink';

docs/products/rarime/overview.mdx → docs/rarime/overview.mdx

@@ -1,5 +1,5 @@
 ---
-slug: /products/rarime
+slug: /rarime
 title: RariMe Identity Wallet
 description: RariMe is a digital identity wallet MetaMask snap
 ---

docs/products/base-layer/overview.mdx → docs/rarimo-core/overview.mdx

@@ -1,10 +1,12 @@
 ---
-slug: /products/base-layer
-description: Rarimo Base Layer is a decentralized interchain messaging protocol.
+slug: /rarimo-core
+description: Rarimo Core is a decentralized interchain messaging protocol.
+# TODO: rewrite
 ---
 import IdealImage from '@site/src/components/IdealImage';
+import OutLink from "@site/src/components/OutLink";
 
-# Base Layer
+# Rarimo Core
 
 The crypto community strongly believes in a multichain future where each project brings its unique perspective and value proposition.
 However, this diversity introduces a plethora of interoperability, security, fragmentation, and other challenges.
@@ -24,7 +26,7 @@ Oracles observe events in the outer world in a trustless way, and Validators col
 
 The protocol provides a general messaging protocol foundation for cross-chain use cases.
 Users can implement their own sub-protocols and submit them via the proposals mechanism.
-Rarimo offers ready-to-use [identity](/products/identity-protocol) sub-protocol.
+Rarimo offers ready-to-use [identity](/credential-trees) sub-protocol.
 
 <IdealImage img={require('/img/protocol-layers.png')} alt="Rarimo Protocols" />
 
@@ -41,3 +43,21 @@ Thus, the pool of validators can be scaled while keeping fees at the destination
 Every step in the cross-chain path adds an extra delay.
 The protocol uses the proven Tendermint consensus mechanism with instant finality to minimize this overhead.
 It only takes an extra few seconds to ensure the protocol's security.
+
+
+## Architecture
+
+Based on Tendermint + Cosmos SDK blockchain core the main goal is to provide validated information about different cross-chain operations.
+
+Rarimo business logic is split into two modules: `x/rarimocore` and `x/tokenmanager`.
+
+The `rarimocore` cosmos module contains logic for all cross-chain operations, its votes, confirmations and signers management.
+
+The common flow consists of three steps:
+
+1. Any Oracle creates the operation on the core
+2. Oracles vote for the operation correctness, and after that operation defined as approved/not approved.
+3. Signature producers sign the operation
+4. Signature producers submit confirmation to the core, and after that operation defined as signed.
+
+See <OutLink href="https://github.com/rarimo/rarimo-core">rarimo-core</OutLink> repository for more details.

docs/products/base-layer/staking-guide.mdx → docs/rarimo-core/staking-guide.mdx

@@ -1,7 +1,7 @@
 ---
 title: Staking your RMO tokens
 description: Learn how the proof-of-stake works and how to stake your RMO tokens
-slug: /products/base-layer/guide-staking-your-rmo-tokens
+slug: /rarimo-core/guide-staking-your-rmo-tokens
 ---
 
 import OutLink from "@site/src/components/OutLink";
@@ -30,7 +30,7 @@ It is planned to be 50 later.
 
 ## Staking and delegations
 
-The following [guide](/products/base-layer/guide-becoming-a-rarimo-validator) explains how to set up a validator node and how to stake the tokens.
+The following [guide](/rarimo-core/guide-becoming-a-rarimo-validator) explains how to set up a validator node and how to stake the tokens.
 The validator **should** stake a required amount of tokens by himself before token holders would be able to delegate their stake to the validator.
 
 When one delegates tokens to a Validator, they are issued a number of "shares" based on a dynamic exchange rate, calculated as:

docs/products/base-layer/validator-node-operator-guide.mdx → docs/rarimo-core/validator-node-operator-guide.mdx

@@ -1,7 +1,7 @@
 ---
 title: Becoming a Rarimo validator
 description: Learn how to become a Rarimo Mainnet validator
-slug: /products/base-layer/guide-becoming-a-rarimo-validator
+slug: /rarimo-core/guide-becoming-a-rarimo-validator
 ---
 import OutLink from "@site/src/components/OutLink";
 

docs/resources/glossary.mdx

@@ -115,7 +115,7 @@ NFTs are different from fungible tokens such as BTC and ETH because fungible tok
 
 In general blockchain terms, Oracles provide information from outside a blockchain to smart contracts on the blockchain.
 Rarimo oracles observe blockchains for events, deliver these events to the Rarimo core, and verify events from other oracles.
-See [Oracles](/products/base-layer/oracles/).
+See [Oracles](/rarimo-core/oracles/).
 
 ## Passport-Derived Profile
 
@@ -197,7 +197,7 @@ On a high level, it's an easy solution to create your own blockchain, which can
 
 TSS is a cryptographic method to produce a single signature from a pool of parties, none of which have access to all of the keys to create the signature by themselves.
 This process uses distributed key generation (DKG) to generate the key.
-See [TSS](/products/base-layer/threshold-signature/).
+See [TSS](/rarimo-core/threshold-signature/).
 
 ## Validator
 

docs/use-cases/social-graphs.mdx

@@ -44,7 +44,7 @@ Using such proofs also makes for identity providers minting identity quite easy
 
 Rarimo is a cross-chain interoperability protocol for the social layer. It provides trustless oracles of on-chain events from all supported blockchains, a cost-efficient way to bridge the assets or data, and EVM-compatible smart contracts for additional flexibility.
 
-A combination of [threshold signature technology(TSS)](/products/base-layer/threshold-signature/), instant finality, EVM transaction bundling, and low protocol fees make cross-chain interactions affordable and hassle-free for the end user.
+A combination of [threshold signature technology(TSS)](/rarimo-core/threshold-signature/), instant finality, EVM transaction bundling, and low protocol fees make cross-chain interactions affordable and hassle-free for the end user.
 
 For social graph developers, the protocol provides:
 

nginx.conf

@@ -126,10 +126,6 @@ http {
         # Redirects
 
         ## architecture -> overview
-        location /architecture {
-            rewrite ^/architecture$ /overview
-            permanent;
-        }
 
         location /use-cases/ssi {
             rewrite ^/use-cases/ssi$ /use-cases/self-sovereign-identity
@@ -191,30 +187,11 @@ http {
 
         ### identity-protocol
 
-        location /overview/identity {
-            rewrite ^/overview/identity$ /products/identity-protocol
-            permanent;
-        }
-
-        location /how-to-guides/setup-issuer {
-            rewrite ^/how-to-guides/setup-issuer$ /products/identity-protocol/guide-how-to-set-up-credentials-issuer
-            permanent;
-        }
+        # location /products/identity-protocol/overview {
+        #     rewrite ^/overview/identity$ /products/identity-protocol
+        #     permanent;
+        # }
 
-        location /how-to-guides/zkp-verification {
-            rewrite ^/how-to-guides/zkp-verification$ /products/identity-protocol/guide-how-to-verify-zero-knowledge-proof-in-a-smart-contract
-            permanent;
-        }
-
-        location /reference/sdk/packages-identity {
-            rewrite ^/reference/sdk/packages-identity$ /products/identity-protocol/js-sdk-reference
-            permanent;
-        }
-
-        location /reference/contracts/identity {
-            rewrite ^/reference/contracts/identity$ /products/identity-protocol/smart-contracts-reference
-            permanent;
-        }
 
 
         ### rarime