Tweaked titles

rarimo · Feb 20, 2024 · 3466454 · 3466454
1 parent 5571f49
commit 3466454
Show file tree

Hide file tree

Showing 13 changed files with 70 additions and 27 deletions.
diff --git a/docs/ecosystem/polygon-id-state-replication/api-reference.mdx b/docs/ecosystem/polygon-id-state-replication/api-reference.mdx
@@ -1,24 +1,28 @@
 ---
+sidebar_label: API reference
+description: This page contains technical resources related to the Polygon ID State Replication.
+
 ---
+import OutLink from "@site/src/components/OutLink";
 
-# API reference
+# Polygon ID State Replication: API reference
 
 This page contains technical resources related to the [Polygon ID State Replication](/ecosystem/polygon-id-state-replication).
 
 ## Demo DApp
 
 Users can check out how the state replication works using our demo DApp. Leveraging the state replication lets users submit a Polygon ID zero-knowledge proof on Ethereum. Users get an SBT as a reward.
 
-Testnet(Sepolia): https://polygon.mainnet-beta.rarimo.com/
+Testnet(Sepolia): <OutLink href="https://polygon.mainnet-beta.rarimo.com/">`https://polygon.mainnet-beta.rarimo.com/`</OutLink>
 
 ## Identity relayer
 
 This service replicates GIST roots and identity states on demand.
 Call it before submitting proof on the destination chain.
 
-- Github: https://github.com/rarimo/identity-relayer-svc
-- API Reference: https://rarimo.github.io/rarimo-core/docs/common/bridging/002-identity.html
-- Testnet URI: https://api.mainnet-beta.rarimo.com/integrations/relayer/
+- GitGub: <OutLink href="https://github.com/rarimo/identity-relayer-svc">`https://rarimo.github.io/identity-relayer-svc/`</OutLink>
+- API Reference: <OutLink href="https://rarimo.github.io/rarimo-core/docs/common/bridging/002-identity.html">`https://rarimo.github.io/rarimo-core/docs/common/bridging/002-identity.html`</OutLink>
+- Testnet URI: <OutLink href="https://api.mainnet-beta.rarimo.com/integrations/relayer/">`https://api.mainnet-beta.rarimo.com/integrations/relayer/`</OutLink>
 
 ### Relayer endpoints
 

diff --git a/docs/ecosystem/polygon-id-state-replication/smart-contracts-reference.mdx b/docs/ecosystem/polygon-id-state-replication/smart-contracts-reference.mdx
@@ -1,6 +1,11 @@
+---
+sidebar_label: 'Smart contracts reference'
+description: 'Information about the smart contracts used in the Polygon ID State Replication.'
+---
+
 import OutLink from "@site/src/components/OutLink";
 
-# Smart contracts reference
+# Polygon ID State Replication: Smart contracts reference
 
 <!-- TODO: Add mainnet contracts addresses -->
 

diff --git a/docs/ecosystem/proof-of-humanity/api-reference.mdx b/docs/ecosystem/proof-of-humanity/api-reference.mdx
@@ -1,34 +1,41 @@
-# API reference
+---
+sidebar_label: API reference
+description: Proof of Humanity API reference and endpoints.
+---
+import OutLink from "@site/src/components/OutLink";
+
+
+# Proof of Humanity API reference
 
 This section contains all Proof of Humanity-related endpoints.
 
 ## User-facing DApp
 
 Users can get verified using the following DApps:
 
-- Mainnet(Polygon): https://robotornot.rarimo.com
+- Mainnet(Polygon): <OutLink href="https://robotornot.rarimo.com">`https://robotornot.rarimo.com`</OutLink>
 
-- Testnet(Goerli): https://robotornot.mainnet-beta.rarimo.com
+- Testnet(Goerli): <OutLink href="https://robotornot.mainnet-beta.rarimo.com">`https://robotornot.mainnet-beta.rarimo.com`</OutLink>
 
 
 ### KYC service
 
 This service is responsible for the verification of users.
 
-GitHub: https://github.com/rarimo/kyc-service
+GitHub: <OutLink href="https://github.com/rarimo/kyc-service">rarimo/kyc-service</OutLink>
 
 <!-- TODO: add docs -->
 
 ### Issuer
 
 This service issues verifiable credentials for verified users.
 
-GitHub: https://github.com/rarimo/issuer
+GitHub: <OutLink href="https://github.com/rarimo/issuer">rarimo/issuer</OutLink>
 
 <!-- TODO: add docs -->
 
 #### Endpoints
 
-| Mainnet | https://api.robotornot.rarimo.com              |
+| Mainnet | <OutLink href="https://api.robotornot.rarimo.com">`https://api.robotornot.rarimo.com`</OutLink> |
 | ------- | ---------------------------------------------- |
-| Testnet | https://api.robotornot.mainnet-beta.rarimo.com |
+| Testnet | <OutLink href="https://api.robotornot.mainnet-beta.rarimo.com">`https://api.robotornot.mainnet-beta.rarimo.com`</OutLink> |
diff --git a/docs/ecosystem/proof-of-humanity/smart-contracts-reference.mdx b/docs/ecosystem/proof-of-humanity/smart-contracts-reference.mdx
@@ -1,9 +1,10 @@
 ---
 description: Proof of Humanity smart contracts interfaces, deployments and reference.
+sidebar_label: Smart contracts reference
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# Smart contracts reference
+# Proof of Humanity smart contracts reference
 
 To make the Proof of Humanity verification result easily re-usable and to enable easy integration with existing DApps like quest platforms, each verified user gets a soulbound token(SBT).
 

diff --git a/docs/ecosystem/proof-of-humanity/subgraph-reference.mdx b/docs/ecosystem/proof-of-humanity/subgraph-reference.mdx
@@ -1,14 +1,20 @@
-# Subgraph reference
+---
+sidebar_label: Subgraph reference
+description: Subgraph reference for the Proof of Humanity
+---
+import OutLink from "@site/src/components/OutLink";
+
+# Proof of Humanity subgraph reference
 
 Subgraph indexes the verified users from the `SBTIdentityVerifier` contract and serves the data via a GraphQL API.
 
 ## Deployments
 
 GraphQL endpoints:
 
-- Mainnet(indexes events from Polygon): https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier-polygon/graphql
+- Mainnet(indexes events from Polygon): <OutLink href="https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier-polygon/graphql">`https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier-polygon/graphql`</OutLink>
 
-- Testnet(indexes events from Goerli testnet): https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier/graphql
+- Testnet(indexes events from Goerli testnet): <OutLink href="https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier/graphql">`https://api.thegraph.com/subgraphs/name/volodymyrzolotukhin/sbtidentityverifier/graphql`</OutLink>
 
 ## Querying
 

diff --git a/docs/ecosystem/token-agnostic-payments/js-sdk-reference.mdx b/docs/ecosystem/token-agnostic-payments/js-sdk-reference.mdx
@@ -1,8 +1,10 @@
 ---
+sidebar_label: JS-SDK reference
+description: Technical reference for the Token-Agnosti Payments SDK checkout packages.
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# JS-SDK reference
+# Token Agnostic Payments JS-SDK reference
 
 The Rarimo SDK checkout packages provide tools to send transactions to blockchains.
 

diff --git a/docs/ecosystem/worldcoin-state-replication/api-reference.mdx b/docs/ecosystem/worldcoin-state-replication/api-reference.mdx
@@ -1,9 +1,11 @@
 ---
 draft: true
+sidebar_label: "API reference"
+description: "This page contains technical resources related to the World ID State Replication."
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# API reference
+# World Coin State Replication API reference
 
 This page contains technical resources related to the World ID State Replication.
 

diff --git a/docs/ecosystem/worldcoin-state-replication/smart-contracts-reference.mdx b/docs/ecosystem/worldcoin-state-replication/smart-contracts-reference.mdx
@@ -1,9 +1,11 @@
 ---
 draft: true
+sidebar_label: Smart contracts reference
+description: 'Information about the smart contracts used in the WorldCoin State Replication.'
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# Smart contracts reference
+# WorldCoin State Replication smart contracts reference
 
 ## `IdentityManager`
 

diff --git a/docs/products/base-layer/api-reference.mdx b/docs/products/base-layer/api-reference.mdx
@@ -1,8 +1,13 @@
+---
+sidebar_label: "API Reference"
+description: "This page lists all public APIs of Rarimo Base Layer services."
+---
+
 import OutLink from "@site/src/components/OutLink";
 
-# API reference
+# Base Layer API reference
 
-This page lists all public APIs of Rarimo services.
+This page lists all public APIs of Rarimo Base Layer services.
 
 :::tip
 Check the health and availability of the endpoints using this <OutLink href="https://monitoring.tokend.io/status/rarimo">monitor</OutLink>.

diff --git a/docs/products/bridging-protocol/js-sdk-reference.mdx b/docs/products/bridging-protocol/js-sdk-reference.mdx
@@ -1,8 +1,10 @@
 ---
+sidebar_label: "JS-SDK reference"
+description: "Rarimo's JavaScript SDK provides tools to interact with browser-based wallets and bridge tokens."
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# JS-SDK reference
+# Bridging Protocol JS-SDK reference
 
 Rarimo's JavaScript SDK provides tools to interact with browser-based wallets and send transactions from wallets to Rarimo's contracts.
 

diff --git a/docs/products/identity-protocol/js-sdk-reference.mdx b/docs/products/identity-protocol/js-sdk-reference.mdx
@@ -1,8 +1,10 @@
 ---
+sidebar_label: JS-SDK reference
+description: The Rarimo SDK identity packages provide tools for the identity protocol.
 ---
 import OutLink from "@site/src/components/OutLink";
 
-# JS-SDK reference
+# Identity Protocol JS-SDK reference
 
 The Rarimo SDK identity packages provide tools for the identity protocol.
 

diff --git a/docs/products/identity-protocol/smart-contracts-reference.mdx b/docs/products/identity-protocol/smart-contracts-reference.mdx
@@ -1,9 +1,11 @@
 ---
+sidebar_lablel: "Smart contracts reference"
+description: "Smart contracts reference for Rarimo's identity protocol."
 ---
 import OutLink from "@site/src/components/OutLink";
 
 
-# Smart contracts reference
+# Identity Protocol smart contracts reference
 
 Rarimo builds upon the basic <OutLink href="https://github.com/iden3/contracts">Iden3 smart contracts</OutLink> and adapts them for cross-chain usage.
 

diff --git a/docs/products/rarime/js-connector-reference.mdx b/docs/products/rarime/js-connector-reference.mdx
@@ -1,10 +1,13 @@
 ---
-sidebar_label: JS connector reference
+sidebar_label: JS-SDK reference
+title: RariMe JS-SDK reference
+description: RariMe JS-SDK provides an interface for interaction with the RariMe MetaMask snap.
 ---
 import OutLink from "@site/src/components/OutLink";
 
+# RariMe JS-SDK reference
 
-# `@rarimo/rarime-connector`
+## `@rarimo/rarime-connector`
 
 The <OutLink href="https://www.npmjs.com/package/@rarimo/rarime-connector">@rarimo/rarime-connector</OutLink> package provides an interface for interaction with the RariMe MetaMask snap. It is the recommended way of interacting with the identity protocol.
 Please use other packages only for custom integrations or low-level utilities.