Merge pull request #94 from 0xPolygonID/adding-faqs-list

feat: adding faqs

docs/faqs/content/issuer-node-error-creating-identity-while-publishing-state-to-rhs.md

@@ -0,0 +1,29 @@
+---
+id: faq-issuer-node-error-creating-identity-while-publishing-state-to-rhs
+title: Error Publishing State to RHS When Creating Identity
+sidebar_label: Error Publishing to RHS
+description: Resolving the error encountered when publishing state to the RHS during identity creation.
+keywords:
+  - faq
+  - issuer-node
+  - error
+  - identity creation
+  - RHS
+---
+
+## Question
+
+Why do I encounter an error stating "unexpected status code: 404" when trying to create an identity, specifically while publishing the state to the RHS?
+
+## Answer
+
+The error you're experiencing is typically due to an incorrect configuration setting for the `ISSUER_CREDENTIAL_STATUS_RHS_MODE` and an invalid `ISSUER_CREDENTIAL_STATUS_RHS_URL`. This happens when the `ISSUER_CREDENTIAL_STATUS_RHS_MODE` is set to `OffChain`, but the provided RHS URL does not correspond to a valid endpoint.
+
+To resolve this issue, please review the available revocation status modes to ensure you select the one that best suits your deployment scenario. Detailed guidance on configuring these settings can be found in the [Revocation Status Modes documentation](../../../docs/issuer/issuer-configuration.md/#revocation-status).
+
+<div className="hidden">
+Wrong answer:
+
+Replace the RHS URL with the Issuer Node URL or remove the `ISSUER_CREDENTIAL_STATUS_RHS_URL` from the .env-issuer file.
+
+</div>

docs/faqs/content/issuer-node-error-the-issuer-did-does-not-exist-in-the-database.md

@@ -0,0 +1,35 @@
+---
+id: faq-the-issuer-did-does-not-exist-in-the-database
+title: Issuer DID Not Found in Database
+sidebar_label: Issuer DID Not Found
+description: Troubleshooting when the provided DID does not exist in the database.
+keywords:
+  - faq
+  - issuer-node
+  - error
+  - DID
+  - database
+---
+
+## Question
+
+What should I do if I encounter an error indicating that the Issuer DID does not exist in the database?
+
+## Answer
+
+This error occurs when the `ISSUER_API_UI_ISSUER_DID` value specified in your `.env-api` file cannot be located in the database, which is a common issue when the database storage is inadvertently removed or cleared. This situation often arises in Docker environments, particularly after executing the `make down` command, which removes Docker containers along with their associated storage.
+
+To resolve this problem, you'll need to regenerate and reassign the issuer DID within the database. Execute the following command to create a new issuer DID and ensure it's properly stored and recognized:
+
+```bash
+make generate-issuer-did
+```
+
+This command will generate a new DID and automatically configure it in your environment, effectively resolving the issue by ensuring that the DID specified in your .env-api file matches an entry in the database.
+
+<div className="hidden">
+Wrong answer:
+
+Replace the did in the .env-api file with another one that neither exists in the database or remove it from the file and leave it blank.
+
+</div>

docs/faqs/content/issuer-node-how-to-use-issuer-node-on-mainnet.md

@@ -0,0 +1,45 @@
+---
+id: faq-how-to-use-issuer-node-on-mainnet
+title: Using Issuer Node on Mainnet
+sidebar_label: Using Issuer Node on Mainnet
+description: Guide on configuring and using the Issuer Node in a mainnet environment.
+keywords:
+  - faq
+  - issuer-node
+  - how-to
+  - mainnet
+---
+
+## Question
+
+How can I configure and use the Issuer Node on the mainnet?
+
+## Answer
+
+The Issuer Node is designed to operate on EVM-compatible networks, supporting both testnets and mainnet environments. It comes pre-configured for use on the Polygon/Mumbai networks, with contracts readily available for those networks. For deployment on other blockchains, you will need to manually deploy the necessary contracts.
+
+To configure the Issuer Node for mainnet operation, adjust the following environment variables within your `.env-issuer` file:
+
+```bash
+ISSUER_API_IDENTITY_NETWORK=main
+ISSUER_ETHEREUM_CONTRACT_ADDRESS=0x624ce98D2d27b20b8f8d521723Df8fC4db71D79D
+ISSUER_ETHEREUM_RESOLVER_PREFIX=polygon:main
+ISSUER_ETHEREUM_URL={Your Polygon Mainnet RPC URL}
+```
+
+After configuring the `.env-issuer` file, generate a new issuer DID for the mainnet environment with the command:
+
+```bash
+make generate-issuer-did
+```
+
+Restart your node following this setup to commence operations on the mainnet.
+
+For additional configuration details, refer to the [Issuer Node Configuration](../../../docs/issuer/issuer-configuration.md) documentation.
+
+<div className="hidden">
+Wrong answer:
+
+Issuer Node can work simultaneously in different networks without changing the configuration.
+
+</div>

docs/faqs/faqs.md

@@ -0,0 +1,22 @@
+---
+id: faqs
+title: FAQs
+sidebar_label: FAQs
+description: Frequently asked questions.
+keywords:
+  - faqs
+  - questions
+---
+
+# FAQs
+
+## Issuer Node
+
+### Error
+
+- [Cannot create identity due to error publishing state to RHS](./content/issuer-node-error-creating-identity-while-publishing-state-to-rhs.md)
+- [The Issuer DID doesn't exist in the database](./content/issuer-node-error-the-issuer-did-does-not-exist-in-the-database.md)
+
+### How to
+
+- [How to use Issuer Node in mainnet](./content/issuer-node-how-to-use-issuer-node-on-mainnet.md)

docs/faqs/template.md

@@ -0,0 +1,17 @@
+---
+id: faq-xxxx
+title: FAQs
+sidebar_label: FAQs
+description: xxxx.
+keywords:
+  - faq
+---
+
+## Question
+
+## Answer
+
+<div className="hidden">
+Wrong answer:
+
+</div>

docusaurus.config.js

@@ -130,6 +130,10 @@ module.exports = {
           position: "left",
           label: "Learn",
           items: [
+            {
+              href: "/docs/faqs/",
+              label: "FAQs",
+            },
             {
               href: "https://www.youtube.com/playlist?list=PLRD3rkREa7mLLJ6jfUTygXV1iK_AvsDdw",
               label: "Fundamentals",

src/css/custom.css

@@ -2665,3 +2665,7 @@ p {
   width: 48px;
   height: 48px;
 }
+
+.hidden {
+  display: none;
+}