Docs structure fixes

rarimo · Jan 24, 2024 · 09862b4 · 09862b4
1 parent aa5e467
commit 09862b4
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 61 deletions.
diff --git a/docs/products/bridging-protocol/js-sdk-reference.mdx b/docs/products/bridging-protocol/js-sdk-reference.mdx
@@ -1,5 +1,4 @@
 ---
-sidebar_label: Overview
 ---
 
 # JS-SDK Reference

diff --git a/docs/products/bridging-protocol/overview.mdx b/docs/products/bridging-protocol/overview.mdx
@@ -1,18 +1,19 @@
 ---
+slug: /products/bridging-protocol
 ---
 
-# Overview
+# Bridging Protocol
 
 Bridging Protocol builds upon the base cross-chain messaging layer to facilitate asset transfers. It supports bridging native and fungible tokens, NFTs, and SBTs across all the supported chains.
 
 Currently, it is available for:
 
-- Ethereum;
-- Polygon;
-- Binance Smart Chain;
-- AVAX;
-- Solana;
-- Near;
+- Ethereum
+- Polygon
+- Binance Smart Chain
+- AVAX
+- Solana
+- Near
 
 Let's look at the inner workings of the protocol in a real-world example: a user bridges funds from Ethereum to Polygon to buy an NFT. The diagram below describes the entire flow. Note that a single transaction is submitted on the source chain to perform this complex cross-chain task.
 

diff --git a/...ng-protocol/bridge-protocol-contracts.mdx → ...ol/smart-contracts-reference/overview.mdx b/...ng-protocol/bridge-protocol-contracts.mdx → ...ol/smart-contracts-reference/overview.mdx
@@ -1,4 +1,5 @@
 ---
+slug: /bridge-protocol/smart-contracts-reference
 ---
 
 # Bridge Protocol Contracts

diff --git a/docs/products/identity-protocol/overview.mdx b/docs/products/identity-protocol/overview.mdx
@@ -1,8 +1,8 @@
 ---
-# TODO: add links to relevant guides
+slug: /products/identity-protocol
 ---
 
-# Overview
+# Identity Protocol
 
 ## Problem Statement
 

diff --git a/docs/products/polygon-id-state-replication/overview.mdx b/docs/products/polygon-id-state-replication/overview.mdx
@@ -1,7 +1,8 @@
 ---
+slug: /products/polygon-id-state-replication
 ---
 
-# Overview
+# Polygon ID State Replication
 
 Polygon ID is a self-sovereign identity protocol that allows users to use zero-knowledge proofs to interact with smart contracts based on rich Verifiable Credentials. However, the on-chain usage is limited to the chain to which the credentials are anchored. To explore the synergy between the protocols, a demo that showcases cross-chain Zero-Knowledge Proofs using existing Polygon ID identities was built.
 

diff --git a/docs/products/proof-of-humanity/api-reference.mdx b/docs/products/proof-of-humanity/api-reference.mdx
@@ -0,0 +1,25 @@
+# API reference
+
+This section contains all Proof of Humanity-related endpoints.
+
+### KYC Service
+
+This service is responsible for the verification of users.
+
+GitHub: https://github.com/rarimo/kyc-service
+
+<!-- TODO: add docs -->
+
+### Issuer
+
+This service issues verifiable credentials for verified users.
+
+GitHub: https://github.com/rarimo/issuer
+
+<!-- TODO: add docs -->
+
+#### Endpoints
+
+| Mainnet | https://api.robotornot.rarimo.com              |
+| ------- | ---------------------------------------------- |
+| Testnet | https://api.robotornot.mainnet-beta.rarimo.com |
diff --git a/docs/products/proof-of-humanity/overview.mdx b/docs/products/proof-of-humanity/overview.mdx
@@ -1,7 +1,8 @@
 ---
+slug: /products/proof-of-humanity
 ---
 
-# Overview
+# Proof of Humanity
 
 ## The problem
 

diff --git a/docs/products/rarime/overview.mdx b/docs/products/rarime/overview.mdx
@@ -1 +1,5 @@
+---
+slug: /products/rarime
+---
+
 # Overview
diff --git a/docs/products/rarimo-protocol/overview.mdx b/docs/products/rarimo-protocol/overview.mdx
@@ -1,4 +1,5 @@
 ---
+slug: /products/rarimo-protocol
 ---
 
-# Overview
+# Rarimo Protocol
diff --git a/docs/products/token-agnostic-payments/overview.mdx b/docs/products/token-agnostic-payments/overview.mdx
@@ -1,7 +1,8 @@
 ---
+slug: /products/token-agnostic-payments
 ---
 
-# Overview
+# Token-agnostic payments
 
 Sometimes, Web3 payments may be overwhelming: so many popular tokens, chains, and steps are involved. This abundance of options unnecessarily complicates your product and spoils the user experience. With Rarimo's token-agnostic payments, your customers can pay in any fungible token with just a few clicks. We handle the token swaps and bridging for you.
 

diff --git a/docs/products/worldcoin-state-replication/overview.mdx b/docs/products/worldcoin-state-replication/overview.mdx
@@ -1 +1,5 @@
-# Overview
+---
+slug: /products/worldcoin-state-replication
+---
+
+# World ID State Replication
diff --git a/docs/use-cases.mdx b/docs/use-cases.mdx
diff --git a/docs/whitepaper.mdx b/docs/whitepaper.mdx
diff --git a/nginx.conf b/nginx.conf
@@ -427,7 +427,7 @@ http {
         }
 
         location /reference/contracts/bridge {
-            rewrite ^/reference/contracts/bridge$ /products/bridging-protocol/bridge-protocol-contracts
+            rewrite ^/reference/contracts/bridge$ /products/bridging-protocol/smart-contracts-reference
             permanent;
         }
 

diff --git a/sidebars.js b/sidebars.js
@@ -8,7 +8,12 @@ const sidebars = {
     {
       type: 'category',
       label: 'Use Cases',
-      link: {type: 'doc', id: 'use-cases'},
+      link: {
+        type: 'generated-index',
+        title: 'Use Cases',
+        description: 'Learn about the different use cases for Rarimo Protocol',
+        slug: '/use-cases',
+      },
       collapsed: true,
       items: [
         'use-cases/gaming-profiles',
@@ -34,9 +39,9 @@ const sidebars = {
     {
       type: 'category',
       label: 'Rarimo Protocol',
+      link: {type: 'doc', id: 'products/rarimo-protocol/overview'},
       collapsed: true,
       items: [
-        'products/rarimo-protocol/overview',
         'products/rarimo-protocol/oracles',
         'products/rarimo-protocol/oraclemanager',
         'products/rarimo-protocol/threshold-signature',
@@ -49,9 +54,9 @@ const sidebars = {
     {
       type: 'category',
       label: 'Identity Protocol',
+      link: {type: 'doc', id: 'products/identity-protocol/overview'},
       collapsed: true,
       items: [
-        'products/identity-protocol/overview',
         'products/identity-protocol/guide-how-to-set-up-credentials-issuer',
         'products/identity-protocol/guide-how-to-verify-zero-knowledge-proof-in-a-smart-contract',
         'products/identity-protocol/api-reference',
@@ -62,19 +67,19 @@ const sidebars = {
     {
       type: 'category',
       label: 'RariMe',
+      link: {type: 'doc', id: 'products/rarime/overview'},
       collapsed: true,
       items: [
-        'products/rarime/overview',
         'products/rarime/js-library-reference',
         'products/rarime/guide-for-issuers',
       ],
     },
     {
       type: 'category',
       label: 'Proof of Humanity',
+      link: {type: 'doc', id: 'products/proof-of-humanity/overview'},
       collapsed: true,
       items: [
-        'products/proof-of-humanity/overview',
         {
           type: 'category',
           label: 'Guides',
@@ -94,9 +99,9 @@ const sidebars = {
     {
       type: 'category',
       label: 'Polygon ID State Replication',
+      link: {type: 'doc', id: 'products/polygon-id-state-replication/overview'},
       collapsed: true,
       items: [
-        'products/polygon-id-state-replication/overview',
         'products/polygon-id-state-replication/guide-how-to-set-up-polygon-id-state-replication',
         // TODO: come up with a good example DApp
         'products/polygon-id-state-replication/tutorial-verifying-polygon-id-credentials-in-ethereum-dapp',
@@ -108,9 +113,9 @@ const sidebars = {
       type: 'category',
       // TODO: come up with a better name
       label: 'WorldCoin State Replication',
+      link: {type: 'doc', id: 'products/worldcoin-state-replication/overview'},
       collapsed: true,
       items: [
-        'products/worldcoin-state-replication/overview',
         'products/worldcoin-state-replication/guide-state-replication-for-world-id',
         'products/worldcoin-state-replication/tutorial-using-world-id-zero-knowledge-proofs-in-avalanche-dapp',
         'products/worldcoin-state-replication/smart-contracts-reference',
@@ -120,9 +125,9 @@ const sidebars = {
     {
       type: 'category',
       label: 'Bridging Protocol',
+      link: {type: 'doc', id: 'products/bridging-protocol/overview'},
       collapsed: true,
       items: [
-        'products/bridging-protocol/overview',
         'products/bridging-protocol/circle-cctp-integration',
         'products/bridging-protocol/guide-how-to-bundle-transactions',
         'products/bridging-protocol/connecting-to-wallets',
@@ -133,6 +138,7 @@ const sidebars = {
         {
           type: 'category',
           label: 'Smart Contracts Reference',
+          link: {type: 'doc', id: 'products/bridging-protocol/smart-contracts-reference/overview'},
           collapsed: true,
           items: [
             'products/bridging-protocol/smart-contracts-reference/evm',
@@ -147,9 +153,9 @@ const sidebars = {
     {
       type: 'category',
       label: 'Token Agnostic Payments',
+      link: {type: 'doc', id: 'products/token-agnostic-payments/overview'},
       collapsed: true,
       items: [
-        'products/token-agnostic-payments/overview',
         'products/token-agnostic-payments/js-sdk-reference',
         'products/token-agnostic-payments/api-reference',
       ],
@@ -173,7 +179,11 @@ const sidebars = {
     {
       type: 'category',
       label: 'Whitepaper',
-      link: {type: 'doc', id: 'whitepaper'},
+      link: {
+        type: 'generated-index',
+        title: 'Whitepaper',
+        slug: '/whitepaper',
+      },
       collapsed: true,
       items: [
         'whitepaper/abstract',