Merge pull request #35 from 0xPolygonID/general-improvements

Improved docs

docs/contracts/credential-linkage.md

@@ -19,15 +19,20 @@ There are 2 types of relationships between credentials and their issuers:
 
 ![img](/img/anchoring-linkage.png)
 
-!!!note
-    If the credential is issued using the MTP method, then the credential data is also “anchored” (via an indirect merkle tree proof) to the blockchain. Otherwise, only the Issuer’s DID is anchored to the blockchain.
+:::note
+
+If the credential is issued using the MTP method, then the credential data is also “anchored” (via an indirect merkle tree proof) to the blockchain. Otherwise, only the Issuer’s DID is anchored to the blockchain.
 
+:::
 
 ## Credential Linkage to Different Blockchains
 
 Credentials could be linked to different Ethereum Virtual Machine (EVM) blockchains, they are not limited to only being linked to the Polygon Mainnet when they are issued. For instance, credentials could be linked to a Supernets chain or another EVM chain. The issuer state contract could be deployed to other EVM-compatible chains, and verifiers could validate the proofs from these credentials as long as they have access to the particular chain. 
 
-!!!note
-    Credential linkage is only supported for a single chain for each credential (a credential cannot be linked to multiple blockchains at the same time).
+:::note
+
+Credential linkage is only supported for a single chain for each credential (a credential cannot be linked to multiple blockchains at the same time).
+
+:::
 
 ![img](/img/linkage-multiple.png)

docs/issuer-node/issue-credential-cli.md

@@ -29,7 +29,7 @@ These steps can be done either via the API UI (<http://localhost:3001>) or direc
 
 :::note
 
-This is an alternative to the following: [Create Issuer ID](../issuer/setup-issuer-ui.md#create-issuer-did).
+This is an alternative to the following: [<ins>Create Issuer ID</ins>](/docs/issuer/setup-issuer-ui.md#create-issuer-did).
 
 :::
 
@@ -56,7 +56,7 @@ A connection is a DID that is linked to the issuer when they authenticate via an
 
 :::note
 
-You can check all the connections on the [Issue Node UI](issuer-node-guide.md#connections).
+You can check all the connections on the [<ins>Issue Node UI</ins>](issuer-node-guide.md#connections).
 
 :::
 
@@ -86,7 +86,7 @@ This will go through creating a `KYCAgeCredential` credential based on the follo
 
 :::note
 
-Learn how to create credentials on [the Issuer Node guide](issuer-node-guide.md#schemas).
+Learn how to create credentials on [<ins>the Issuer Node guide</ins>](issuer-node-guide.md#schemas).
 
 :::
 
@@ -146,7 +146,7 @@ This will walk you through the steps of issuing a credential to the Polygon ID w
 
 :::note 
 
-To learn how to issue credentials to a Polygon ID Wallet User, please refer to the [Issuer Node Guide](issuer-node-guide.md#schemas).
+To learn how to issue credentials to a Polygon ID Wallet User, please refer to the [<ins>Issuer Node Guide</ins>](issuer-node-guide.md#schemas).
 
 :::
 

docs/issuer-node/issuer-node-guide.md

@@ -16,7 +16,7 @@ keywords:
 
 :::info
 
-Before you actually act as an Issuer and provide credentials, you need to set up a Polygon ID Issuer Node. You can find instructions to get your Issuer Node up and running [here](/docs/issuer/setup-issuer-ui.md).
+Before you actually act as an Issuer and provide credentials, you need to set up a Polygon ID Issuer Node. You can find instructions to get your Issuer Node up and running [<ins>here</ins>](/docs/issuer/setup-issuer-ui.md).
 
 :::
 
@@ -125,7 +125,7 @@ If you already have a connection with an identifier or you have its DID, you can
 
 :::note
 
-If you clicked on the **Issue credential** button, you will later be prompted to choose which Schema Type you woullike to create your credential with.
+If you clicked on the **Issue credential** button, you will later be prompted to choose which Schema Type you would like to create your credential with.
 
 <div align="center">
 <img src= "/img/issue-credential-3.png" align="center" width="1000" height="1000"/>

docs/issuer/cred-issue-methods.md

@@ -32,7 +32,7 @@ There are two ways those credentials can be issued: using **BJJ key Signature**
 The credential is not added to the Issuer’s Merkle tree, instead a **Baby Jubjub (BJJ)** signature is used which is then verified upon presentation. With this method, issuers can issue a large number of credentials without needing to spend any gas to issue the credentials.
 
 <div align="center">
-<img src= {useBaseUrl("img//img/babyjubjub.png.png")} align="center" />
+<img src= {useBaseUrl("img/babyjubjub.png")} align="center" />
 </div>
 
 ### MTP Method: Issuance of Credentials with Merkle Tree Proof
@@ -42,5 +42,5 @@ The validation of the proof is done against the state published on-chain. No per
 Another important difference is that through this method smart contracts can issue credentials. The estimated cost of calling this function is approximately 2 million gas on average ( 0.36 MATIC in the Polygon PoS mainnet as of June 2023). Furthermore, credential issuance batching could be done to optimize the gas cost of the issuance process.
 
 <div align="center">
-<img src= {useBaseUrl("img//img/mtp.png")} align="center" />
+<img src= {useBaseUrl("img/mtp.png")} align="center" />
 </div>

docs/issuer/issuer-overview.md

@@ -24,7 +24,7 @@ An issuer might be:
 
 :::info
 
-[Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) are a flexible data format able to express any type of information so that developers can unleash their creativity.
+[<ins>Verifiable Credentials</ins>](https://www.w3.org/TR/vc-data-model/) are a flexible data format able to express any type of information so that developers can unleash their creativity.
 
 :::
 

docs/issuer/on-chain-issuer/on-chain-overview.md

@@ -26,7 +26,7 @@ In simple words, you can see everything happening: all the logic used to generat
 
 :::info
         
-An On-chain Issuer, in fact, is a special case of the On-chain Identity. You can find more information about it on the [Iden3 documentation](https://docs.iden3.io/getting-started/identity/onchain-identity/).
+An On-chain Issuer, in fact, is a special case of the On-chain Identity. You can find more information about it on the [<ins>Iden3 documentation</ins>](https://docs.iden3.io/getting-started/identity/onchain-identity/).
 
 :::
 

docs/issuer/on-chain-issuer/on-chain-tutorial.md

@@ -61,7 +61,7 @@ Currently, the state contract on the mainnet does not support onchain issuers. P
 
     :::note
 
-    You can find more information on how to deploy a smart contract using Hardhat [in this readme](https://github.com/iden3/contracts#readme).
+    You can find more information on how to deploy a smart contract using Hardhat [<ins>in this readme</ins>](https://github.com/iden3/contracts#readme).
 
     :::
 
@@ -86,8 +86,8 @@ Currently, the state contract on the mainnet does not support onchain issuers. P
 
 Don't forget to download and install the Polygon ID wallet app before you go the next steps. 
 
-- For Android: <a href="https://play.google.com/store/apps/details?id=com.polygonid.wallet" target="_blank">Polygon ID on Google Play</a>
-- For iOS: <a href="https://apps.apple.com/us/app/polygon-id/id1629870183" target="_blank">Polygon ID on the App Store</a>
+- For Android: <ins><a href="https://play.google.com/store/apps/details?id=com.polygonid.wallet" target="_blank">Polygon ID on Google Play</a></ins>
+- For iOS: <ins><a href="https://apps.apple.com/us/app/polygon-id/id1629870183" target="_blank">Polygon ID on the App Store</a></ins>
 
 :::
 

docs/issuer/schema-builder.md

@@ -92,7 +92,7 @@ The first page of the Schema Builder flow lets you define the basic aspects of t
 </div>
 
 - Title: a name for the schema.
-- Schema Type: a set of attributes used to shape the data stored in one credential. 
+- Schema Type: similar to (and in most cases coincides with) the schema name. The text provided in this field will become the name of the type in the JSON LD context associated with this schema. 
 - Version: this is important to register the current version of the schema, as it might be updated in the future.
 - Description: a description of the schema should explain in simple terms what it will be used for. 
 

docs/issuer/schema.md

@@ -17,7 +17,7 @@ keywords:
 
 :::info
 
-Polygon ID offers an intuitive, user-friendly interface to create schemas: the Schema Builder. [Here](schema-builder.md) you can find a tutorial for this tool. You can also access it on [https://schema-builder.polygonid.me/](https://schema-builder.polygonid.me/). 
+Polygon ID offers an intuitive, user-friendly interface to create schemas: the Schema Builder. [<ins>Here</ins>](schema-builder.md) you can find a tutorial for this tool. You can also access it on <ins>[https://schema-builder.polygonid.me/](https://schema-builder.polygonid.me/)</ins>. 
 
 :::
 
@@ -39,7 +39,7 @@ Without further ado, let's jump into building a new Schema Type!
 
 :::note
 
-The executable code and **further schemas examples** for this section can be found <a href="https://github.com/0xPolygonID/tutorial-examples/tree/main/credential-schema" target="_blank">here</a>. 
+The executable code and **further schemas examples** for this section can be found <ins><a href="https://github.com/0xPolygonID/tutorial-examples/tree/main/credential-schema" target="_blank">here</a></ins>. 
 
 :::
 

docs/issuer/setup-issuer-core.md

@@ -99,7 +99,8 @@ Using Mainnet or Testnet will depend on the RPC URL you are going to use in this
 It is desired to run a public forwarding URL,  pointing to a host, as it is going to be stored inside the credential. Localhost can't be used in this situation because the mobile app can't access it. 
 
 :::note  "Getting a free Public URL"
-For testing purposes, you can use a public URL. A way to set this up is by using [ngrok](https://ngrok.com) as a forwarding service that maps to a local port.
+
+For testing purposes, you can use a public URL. A way to set this up is by using [<ins>ngrok</ins>](https://ngrok.com) as a forwarding service that maps to a local port.
 After downloading and installing ngrok, run the following command and copy the **Forwarding** URL:
 
 ```bash
@@ -218,7 +219,7 @@ In order to secure the wallet private key so that the issuer can use it to issue
 
 :::note
 
-Make sure the wallet that is provided has Testnet Matic to be able to send transactions and that you are providing the Private Key. Here's how you can [extract the private key from MetaMask](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.), for instance.
+Make sure the wallet that is provided has Testnet Matic to be able to send transactions and that you are providing the Private Key. Here's how you can [<ins>extract the private key from MetaMask</ins>](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.), for instance.
 
 :::
 

docs/issuer/setup-issuer-ui.md

@@ -102,7 +102,7 @@ It is desired to run a public forwarding URL, pointing to a host, as it is going
 
 :::note "Getting a free Public URL"
 
-For testing purposes, you can use a public URL. A way to set this up is by using [ngrok](https://ngrok.com) as a forwarding service that maps to a local port.
+For testing purposes, you can use a public URL. A way to set this up is by using [<ins>ngrok</ins>](https://ngrok.com) as a forwarding service that maps to a local port.
 After downloading and installing ngrok, run the following command and copy the **Forwarding** URL:
 
 ```bash
@@ -220,7 +220,7 @@ In order to secure the wallet private key so that the issuer can use it to issue
 
 :::note
 
-Make sure the wallet that is provided has Testnet Matic to be able to send transactions and that you are providing the Private Key. Here's how you can [extract the private key from MetaMask](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.), for instance.
+Make sure the wallet that is provided has Testnet Matic to be able to send transactions and that you are providing the Private Key. Here's how you can [<ins>extract the private key from MetaMask</ins>](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.), for instance.
 
 :::
 
@@ -259,7 +259,7 @@ make add-vault-token;
 
 :::note
 
-This can also be done via the [UI API](#using-the-ui-api).
+This can also be done via the [<ins>UI API</ins>](#using-the-ui-api).
 
 :::
 
@@ -327,7 +327,7 @@ This step is required to run the separate UI application, which allows intuitive
 
 :::tip
 
-Running and using the UI is optional since it implements functionalities already exposed via the [UI API](#using-the-ui-api). It is highly recommended though, because it makes issuer management far simpler and more intuitive.
+Running and using the UI is optional since it implements functionalities already exposed via the [<ins>UI API</ins>](#using-the-ui-api). It is highly recommended though, because it makes issuer management far simpler and more intuitive.
 
 :::
 
@@ -437,7 +437,7 @@ ISSUER_UI_AUTH_PASSWORD=password-ui
 
 :::note
 
-If you want to run the UI app in development mode, i.e. with HMR enabled, please follow the steps in the [Development (UI)](#development-ui) section.
+If you want to run the UI app in development mode, i.e. with HMR enabled, please follow the steps in the [<ins>Development (UI)</ins>](#development-ui) section.
 
 :::