docs: quality triage — broken links, orphaned pages, content fixes (Phase 1 of #8)

SUMMARY.md

@@ -29,6 +29,9 @@
 
 * [Architecture](references/architecture.md)
 * [Platform APIs](references/platform-apis.md)
+* [OID4VC Issuer API](references/oid4vc/OID4VC%20Issuer%20API.md)
+* [OID4VP Verifier API](references/oid4vc/CREDEBL%20OID4VP%20Verifier%20API.md)
+* [Ecosystem & Trust Service](references/ecosystem/ecosystem.md)
 * [FAQs](references/faqs.md)
 * [Glossary](references/glossary.md)
 * [Copyright & License](references/copyright-and-license.md)

contribute/setup/optional-agent.md

@@ -34,17 +34,17 @@ Below is the cliConfig.json file, which needs to be used to set up the agent
 
 <summary>cliConfig.json</summary>
 
-```
+```json
 {
   "label": "AFJ Rest Agent 1",
-  "walletId": "sample",  # Mention your walletId here
-  "walletKey": "sample",   # Mention your walletKey here
-  "walletType": "postgres",  # Mention wallet type here
-  "walletUrl": "localhost:5432",  # Mention your wallet url here
-  "walletAccount": "postgres",  # Mention your wallet account name here
-  "walletPassword": "postgres",   # Mention your wallet password here
+  "walletId": "sample",
+  "walletKey": "sample",
+  "walletType": "postgres",
+  "walletUrl": "localhost:5432",
+  "walletAccount": "postgres",
+  "walletPassword": "postgres",
   "walletAdminAccount": "postgres",
-  "walletAdminPassword": "postgres",,
+  "walletAdminPassword": "postgres",
   "walletScheme": "ProfilePerWallet",
   "indyLedger": [
     {
@@ -80,7 +80,7 @@ Below is the cliConfig.json file, which needs to be used to set up the agent
   "schemaManagerContractAddress": "0x4742d43C2dFCa5a1d4238240Afa8547Daf87Ee7a",
   "rpcUrl": "https://rpc-amoy.polygon.technology",
   "fileServerUrl": "https://schema.credebl.id",
-  "fileServerToken":     #Use your token here
+  "fileServerToken": "<your-token>"
 }
 ```
 
@@ -92,13 +92,13 @@ For polygon mainnet use these configuration
 
 ```json
 "didRegistryContractAddress": "0x0C16958c4246271622201101C83B9F0Fc7180d15",
-"schemaManagerContractAddress": "0x4B16719E73949a62E9A7306F352ec73F1B143c27"
+"schemaManagerContractAddress": "0x4B16719E73949a62E9A7306F352ec73F1B143c27",
 "rpcUrl": "https://polygon-rpc.com"
 ```
 
 _**Description of Fields in cliConfig.json**_
 
-* **referringlabel:** A descriptive name for the agent configuration.
+* **label:** A descriptive name for the agent configuration.
 * **walletId:** The identifier for the wallet used by the agent.
 * **walletKey:** The key or token used to access the wallet.
 * **walletType:** The type of wallet (e.g., PostgreSQL).

contribute/setup/service-setup.md

@@ -31,7 +31,7 @@ Here is the list of prerequisites software we will need for CREDEBL:
 * [PostgreSQL](service-setup.md#postgresql) (>= 14)
 * [NATS](service-setup.md#nats) (>= 2.6.4)
 * [REDIS](service-setup.md#redis) (>= 7.4)
-* [Keycloak](service-setup.md#top) (>= 25.0.6)
+* [Keycloak](service-setup.md#keycloak) (>= 25.0.6)
 * [Sendgrid](service-setup.md#sendgrid)
 * [AWS S3](service-setup.md#aws-s3)
 * [Schema file server](service-setup.md#schema-file-server-optional) (optional)
@@ -60,7 +60,7 @@ If you want to know more about the environment variables, please refer to `.env.
 The email (SendGrid) and AWS S3 credentials can optionally be stored in an OpenBao server instead of the `.env` file. See [OpenBao Secret Storage](../../getting-started/local-deployment/openbao.md).
 {% endhint %}
 
-Apart from the already present variables, you need to add few variables generated from the below prerequisites like the [PostgreSQL](service-setup.md#postgresql), [Keycloak](service-setup.md#top), [Sendgrid](service-setup.md#sendgrid), [AWS S3](service-setup.md#aws-s3), etc at the respective steps. 
+Apart from the already present variables, you need to add few variables generated from the below prerequisites like the [PostgreSQL](service-setup.md#postgresql), [Keycloak](service-setup.md#keycloak), [Sendgrid](service-setup.md#sendgrid), [AWS S3](service-setup.md#aws-s3), etc at the respective steps. 
 
 ### PostgreSQL
 
@@ -70,7 +70,7 @@ In case you already have PostgreSQL preinstalled on your machine, you can simply
 
 PostgreSQL is a powerful, open-source object-relational database system known for its robustness and advanced features. This guide provides instructions for installing and configuring PostgreSQL both natively and using Docker. Installing PostgreSQL
 
-**Initially we'll need to install postures on the host or on docker**
+**Initially we'll need to install PostgreSQL on the host or on Docker**
 
 {% tabs %}
 {% tab title="Ubuntu" %}
@@ -594,7 +594,7 @@ AFJ_VERSION=credo-controller-0.5.3:latest
   Using these cookies, users can fetch their session details.
   * To fetch the session details, call the following API while passing the stored cookies in the request headers`:`
     * `/auth/sessionDetails`
-* For more details visit this - [https://docs.credebl.id/docs/\~/revisions/IXcpHdsfgTsukxV376wG/references/releases/v.2.1.0](https://docs.credebl.id/docs/~/revisions/IXcpHdsfgTsukxV376wG/references/releases/v.2.1.0#sso-single-sign-on)  
+* For more details, see [SSO (Single Sign-On) in release v.2.1.0](../../references/releases/v.2.1.0.md#sso-single-sign-on).
 
 ## Installations
 
@@ -614,7 +614,7 @@ Before you start the services make sure to update the `credebl-master-table.json
   },
 </code></pre>
 
-At the root of the [platfrom repo](service-setup.md#clone-repository):
+At the root of the [platform repo](service-setup.md#clone-repository):
 
 ```sh
 cd libs/prisma-service

contribute/setup/studio.md

@@ -11,14 +11,14 @@ Clone the studio repository:
 
 Create a .env file and set the required environment variables as per the `.env.demo` file.
 
-*   Update the Keycloak 
+*   Update the Keycloak
 
-    * For older version 
+    * For versions before v2.1.0
       * **`PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**
-    * For newer version (v2.1.0)
+    * For v2.1.0 and above
       * **`NEXT_PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**
 
-    You can get this value from your platform environment variables or directly from the Keyclock dashboard.
+    You can get this value from your platform environment variables or directly from the Keycloak dashboard.
 * In version v2.1.0, we have implemented NextAuth for SSO. To run the application, please refer to the `env.demo` file for the required NextAuth-related values.
 * `NEXTAUTH_SECRET` Generate this secret by referring [here](https://next-auth.js.org/configuration/options#nextauth_secret.) (Only for v2.1.0).
 *   Add the backend URL for `PUBLIC_ALLOW_DOMAIN`

getting-started/getting-started.md

@@ -5,5 +5,5 @@ icon: star-shooting
 
 # Getting Started
 
-<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Platform APIs</strong></td><td>Start with your local setup of CREDEBL Platform </td><td></td><td><a href="../references/platform-apis.md">platform-apis.md</a></td></tr><tr><td><strong>Studio</strong></td><td>Setup CREDEBL studio</td><td></td><td><a href="local-deployment/studio.md">studio.md</a></td></tr><tr><td><strong>Mobile SDK</strong></td><td>Understand and build identity wallet using SSI Mobile SDK</td><td></td><td><a href="local-deployment/mobile-sdk.md">mobile-sdk.md</a></td></tr></tbody></table>
+<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Platform</strong></td><td>Start with your local setup of CREDEBL Platform </td><td></td><td><a href="local-deployment/platform.md">platform.md</a></td></tr><tr><td><strong>Studio</strong></td><td>Setup CREDEBL studio</td><td></td><td><a href="local-deployment/studio.md">studio.md</a></td></tr><tr><td><strong>Mobile SDK</strong></td><td>Understand and build identity wallet using SSI Mobile SDK</td><td></td><td><a href="local-deployment/mobile-sdk.md">mobile-sdk.md</a></td></tr></tbody></table>
 

getting-started/local-deployment/platform.md

@@ -43,10 +43,10 @@ Ensure these ports are not blocked by your firewall or occupied by other applica
 Here is the list of prerequisites we will need for CREDEBL:
 
 * [Docker / Docker compose](https://docs.docker.com/compose/install/standalone/)​
-* [PostgreSQL](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/postgresql) (>= 14)
-* ​[NATS](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/nats) (>= 2.6.4)
-* ​[REDIS](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/redis) (>= 7.4)
-* ​[Keycloak](https://app.gitbook.com/o/V2P788cbocWTT1Z5YOmy/s/nsdydI5ziLfZ8yT3e0r8/~/diff/~/changes/93/~/revisions/TgbJCysW7FmStzyIiou3/contribute/setup/top) (>= 25.0.6)
+* [PostgreSQL](../../contribute/setup/service-setup.md#postgresql) (>= 14)
+* ​[NATS](../../contribute/setup/service-setup.md#nats) (>= 2.6.4)
+* ​[REDIS](../../contribute/setup/service-setup.md#redis) (>= 7.4)
+* ​[Keycloak](../../contribute/setup/service-setup.md#keycloak) (>= 25.0.6)
 * [AWS S3 Configuration Requirements](https://aws.amazon.com/)
   * The platform uses Amazon S3 for secure file storage. Prepare your:
     * AWS Access Key ID
@@ -101,18 +101,18 @@ Your SendGrid API key can optionally be stored in an OpenBao server instead of t
 * Log in to your SendGrid account:
   * Go to [https://app.sendgrid.com](https://login.sendgrid.com/login/password) and sign in with your credentials.
 
-![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdmnR2ZTjWIr9ORfRzVmvYHLrLKN0HSc2Wc1h6K-cLQ4FQJfdTEBlrotNpG2Q851P2OCqSd7U1ezy67E2tHUa7RfnYL9S20bBAYmS42COLpTm8xfXZIOdjS8hOEX1WZCbQCS7gjCg?key=d_qWtjEes9qiiyogS_A3bw)
+![](../../.gitbook/assets/sendgrid/sendgrid-login.png)
 
 * Navigate to API Key Settings:-
   * On the left-hand navigation panel, click on "Settings".
   * Under Settings, select "API Keys".
 
-![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXfy-IUcY6_BTto_2Glo7JSXnmXZVLrR2X8Oudv1F_Tf1CSzQ85Re0RxaSgyWGIgnLCqQsu1x2SRpkCLpfz-jRkDwBlgyz45Pp3Cuyhuf11a-K5NF5dC2LFhK7DdMEMFk0bMfq1hXg?key=d_qWtjEes9qiiyogS_A3bw)
+![](../../.gitbook/assets/sendgrid/sendgrid-settings-api-keys.png)
 
 * Create a New API Key:
   * Click on the "Create API Key" button.
 
-![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeKwFhpTjxrbEOEfo0ndl8bSfBpS1sPnGQgMQWOiU9Sv8qxseMDbVAyW3w5sjh23Ca6g6RK2LHVHHJREEDoT4xBZi_og7i8r5VPhR_f36NY4WTieqOaYW9ETGP7Y0h13-m3WyXN5A?key=d_qWtjEes9qiiyogS_A3bw)
+![](../../.gitbook/assets/sendgrid/sendgrid-create-api-key.png)
 
 * Choose one of the following access levels:
   * Enter a meaningful name for your API key to help you identify its purpose later.
@@ -121,12 +121,12 @@ Your SendGrid API key can optionally be stored in an OpenBao server instead of t
   * Billing Access – Provides access only to billing-related endpoints.
   * Click the "Create & View" button.
 
-![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeCZQrz4sNPFaqjeUWQn7ZT8LirX49yNxW4keyaRlM14cFOG_XOR22LfvHTl8SFfDRyrNmvYOb5r751LGS8XfX0jLU-vel7gve-USCNRySOwBG8HDfkDETbJlxkJaszgwT0qFNUkw?key=d_qWtjEes9qiiyogS_A3bw)
+![](../../.gitbook/assets/sendgrid/sendgrid-create-view.png)
 
 * Secure Your API Key:
   * Your API key will be displayed only once, make sure to copy and save this key securely in a password manager or secure vault.
 
-![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXfaxBTAD_RmN_r_uqStSpLpkId7A89_amkJuAOFv96TSB56tJ0mF7DGKwxfQqoOFN-FYaG0_MK12_nSWLnHUjCNsWT2rt9qT-l5GYNvFDJbX9TnoSn1ySlH6_FbEEeFLDyCq5SR?key=d_qWtjEes9qiiyogS_A3bw)
+![](../../.gitbook/assets/sendgrid/sendgrid-key-reveal.png)
 
 \
 Note:- 
@@ -179,7 +179,7 @@ This script will:
 * Launch all required services in separate terminal tabs (each tab will be automatically named for its service, and new services will start a few seconds apart)
 
 After the script completes, the backend and agent services will be running.\
-You will need to start the frontend separately by following the instructions [here](https://docs.credebl.id/docs/contribute/setup/studio).
+You will need to start the frontend separately by following the instructions [here](../../contribute/setup/studio.md).
 
 #### Option 2: Docker Deployment
 
@@ -279,8 +279,7 @@ Keycloak
 
 * #### **Access the CREDEBL API**
 
-Once all containers are running, you can access the CREDEBL API\
-
+Once all containers are running, you can access the CREDEBL API at [http://localhost:5000](http://localhost:5000).
 
 ### **Tearing Down the Infrastructure**
 

getting-started/local-deployment/studio.md

@@ -1,5 +1,5 @@
 ---
-description: Follow this guides to setup STUDIO locally -
+description: Follow this guide to set up Studio locally
 icon: browsers
 ---
 
@@ -18,12 +18,12 @@ cd studio
 * Create a .env file and set the required environment variables as per the `.env.demo` file.
   *   Update the Keycloak credentials
 
-      * For older version (>v2.1.0)
+      * For versions before v2.1.0
         * **`PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**
-      * For newer version (v2.1.0)
+      * For v2.1.0 and above
         * **`NEXT_PUBLIC_KEYCLOAK_MANAGEMENT_CLIENT_SECRET`**
 
-      You can get this value from your platform environment variables or directly from the Keyclock dashboard.
+      You can get this value from your platform environment variables or directly from the Keycloak dashboard.
   * In version v2.1.0, we have implemented NextAuth for SSO. To run the application, please refer to the `env.demo` file for the required NextAuth-related values.
   * `NEXTAUTH_SECRET` Generate this secret by referring [here](https://next-auth.js.org/configuration/options#nextauth_secret.) (Only for v 2.1.0).
   *   Add the backend URL for `PUBLIC_ALLOW_DOMAIN`

introduction/concepts.md

@@ -68,7 +68,7 @@ A credential definition (CRED\_DEF or CLAIM\_DEF) contains the public data neede
 
 ## Wallet
 
-wallet is a digital application that securely stores and manages a user's verifiable credentials and decentralized identifiers (DIDs). It allows individuals to control their data, facilitating the issuance, storage, and sharing of identity information without relying on central authorities. Wallets provide users with an interface to interact with various services, enabling them to present their credentials selectively while maintaining privacy and security.
+A wallet is a digital application that securely stores and manages a user's verifiable credentials and decentralized identifiers (DIDs). It allows individuals to control their data, facilitating the issuance, storage, and sharing of identity information without relying on central authorities. Wallets provide users with an interface to interact with various services, enabling them to present their credentials selectively while maintaining privacy and security.
 
 ### Edge Wallet
 

introduction/features.md

@@ -19,7 +19,7 @@ CREDEBL enables end-to-end verifiable credential management with following key f
 
 ### **User Registration**
 
-The platform provides an efficient user registration process through email-based verification. Furthermore, the platform offers modern & highly secure authentication mechanisms such as FIDO Passkey for phishing-resistent user verification. These measures establish a multi-layered approach to user authentication, mitigating the potential for unauthorized access and preserving the security of sensitive user data. Platform also provides highly secure mechanisms such as ClientId and ClientSecret for API authentication.
+The platform provides an efficient user registration process through email-based verification. Furthermore, the platform offers modern & highly secure authentication mechanisms such as FIDO Passkey for phishing-resistant user verification. These measures establish a multi-layered approach to user authentication, mitigating the potential for unauthorized access and preserving the security of sensitive user data. Platform also provides highly secure mechanisms such as ClientId and ClientSecret for API authentication.
 
 ### **Organization Onboarding**
 
@@ -51,9 +51,10 @@ Verifiable credentials (VCs) have these qualities:
 
 * Portability: You can easily send them to others online.
 * Verifiability: You can check who issued the credential, who holds it, if it’s unchanged, and if it’s valid.
-* Privacy: You can choose what info to share using zero-knowledge proofs, giving you more control.Integrity: VCs can’t be changed or faked.”
+* Privacy: You can choose what info to share using zero-knowledge proofs, giving you more control.
+* Integrity: VCs can’t be changed or faked.
 
-Verification credential Stake-holders:
+Verifiable credential stakeholders:
 
 * Issuer: The entity that generates the Verifiable Credential and provides it to another entity.
 * Holder: The entity that possesses the verifiable credential in their digital wallet.

introduction/use-cases.md

@@ -15,7 +15,7 @@ description: >-
 
 * Boarding Pass, Passport, Visa, Work Authorization
 
-### [Academic Digital Credentials](implementations.md#credebl-saas)
+### [Academic Digital Credentials](implementations.md#sovio.id)
 
 * Student ID, Degree, Diploma, Transcripts, Bonafide, Transfer Certificate
 
@@ -30,14 +30,3 @@ description: >-
 ### Life Events
 
 * Birth Certificate, Death Certificate, Marriage Certificate, etc
-
-
-
-
-
-
-
-
-
-
-

references/copyright-and-license.md

@@ -5,8 +5,8 @@ icon: copyright
 
 # Copyright & License
 
-`Copyright © CREDEBL a Series of LF Projects, LLC. All rights reserved.` 
+Copyright © CREDEBL, a Series of LF Projects, LLC. All rights reserved.
 
-`This project is licensed under the`` `**`Apache License 2.0,`**`which permits users to freely use, modify, and distribute the software, provided that they adhere to the terms and conditions of the license. The Apache License 2.0 ensures that any derivative works must include a copy of the original license and acknowledge the original authors.`
+This project is licensed under the Apache License 2.0, which permits users to freely use, modify, and distribute the software, provided that they adhere to the terms and conditions of the license. The Apache License 2.0 ensures that any derivative works must include a copy of the original license and acknowledge the original authors.
 
 For full details, you can review the [Apache License 2.0](https://github.com/credebl/platform/blob/main/LICENSE) to understand your rights and obligations when using or modifying this software.

references/ecosystem/ecosystem.md

@@ -25,9 +25,6 @@
        - 3.2.6.1 [Create Intent Notice](#3261-create-intent-notice)
        - 3.2.6.2 [Get Intent Notice by Intent ID](#3262-get-intent-notice-by-intent-id)
        - 3.2.6.3 [Update Intent Notice](#3263-update-intent-notice)
-   - 3.3 [Template](#33-template)
-
-4. [Cross-Ecosystem Access](#4-cross-ecosystem-access)
 
 ---
 
@@ -632,7 +629,7 @@ GET /v1/intent/{intentId}/notice
 
 Updates an existing consent notice linked to a specific intent. Use this endpoint when the terms, policies, or data processing rules of a workflow have changed and the notice needs to reflect the latest information.
 
-> **Note:** Updating a notice typically results in a new version being issued. Participants who previously accepted the older version may be may not effect, depending on the platform's consent management policy.
+> **Note:** Updating a notice typically results in a new version being issued. Participants who previously accepted the older version may or may not be affected, depending on the platform's consent management policy.
 
 > **Role required:** Ecosystem Lead and Member
 
@@ -650,5 +647,6 @@ PUT /v1/intent/{intentId}/notice
 
 ---
 
+*Sections covering the credential **Template** registry and **Cross-Ecosystem Access** are planned for a future update.*
 
 *End of document*