diff --git a/documentation/developers/README.md b/documentation/develop/README.md similarity index 99% rename from documentation/developers/README.md rename to documentation/develop/README.md index 51f16e2619..d5bb3e3b58 100644 --- a/documentation/developers/README.md +++ b/documentation/develop/README.md @@ -182,4 +182,4 @@ All SDKs include sample applications demonstrating end-to-end flows: --- -Ready to start building? Head to the [Quick Start Guide](./quick-start.md) to deploy your first Identus application! \ No newline at end of file +Ready to start building? Head to the [Quick Start Guide](./quick-start.md) to deploy your first Identus application! diff --git a/documentation/developers/cloud-agent/_category_.json b/documentation/develop/cloud-agent/_category_.json similarity index 100% rename from documentation/developers/cloud-agent/_category_.json rename to documentation/develop/cloud-agent/_category_.json diff --git a/documentation/developers/cloud-agent/authentication.md b/documentation/develop/cloud-agent/authentication.md similarity index 100% rename from documentation/developers/cloud-agent/authentication.md rename to documentation/develop/cloud-agent/authentication.md diff --git a/documentation/developers/cloud-agent/building-blocks.md b/documentation/develop/cloud-agent/building-blocks.md similarity index 100% rename from documentation/developers/cloud-agent/building-blocks.md rename to documentation/develop/cloud-agent/building-blocks.md diff --git a/documentation/developers/cloud-agent/did-management.md b/documentation/develop/cloud-agent/did-management.md similarity index 100% rename from documentation/developers/cloud-agent/did-management.md rename to documentation/develop/cloud-agent/did-management.md diff --git a/documentation/developers/cloud-agent/environment-variables.md b/documentation/develop/cloud-agent/environment-variables.md similarity index 100% rename from documentation/developers/cloud-agent/environment-variables.md rename to documentation/develop/cloud-agent/environment-variables.md diff --git a/documentation/developers/cloud-agent/node-backend.md b/documentation/develop/cloud-agent/node-backend.md similarity index 94% rename from documentation/developers/cloud-agent/node-backend.md rename to documentation/develop/cloud-agent/node-backend.md index 0dfe6a4455..9303057ae9 100644 --- a/documentation/developers/cloud-agent/node-backend.md +++ b/documentation/develop/cloud-agent/node-backend.md @@ -29,7 +29,7 @@ The legacy PRISM Node implementation uses gRPC for communication and has been th NeoPRISM is an open-source alternative implementation written in Rust. It provides the same DID management capabilities with improved resource efficiency and a modern HTTP/REST API. NeoPRISM is designed for easy deployment with Docker and supports multiple deployment modes. -For more information about NeoPRISM, see the [NeoPRISM component documentation](/docs/documentation/learn/components/neoprism/). +For more information about NeoPRISM, see the [NeoPRISM component documentation](/documentation/learn/advanced-explainers/neoprism/). ## Configuration @@ -76,7 +76,7 @@ To use PRISM Node as the backend, you need: - A deployed PRISM Node instance - Network connectivity to the PRISM Node service -For detailed instructions on deploying and running PRISM Node, see the [Running PRISM Node](/docs/documentation/learn/components/prism-node/running-node) documentation. +For detailed instructions on deploying and running PRISM Node, see the [Running PRISM Node](/documentation/learn/advanced-explainers/prism-node/running-node) documentation. ### For NeoPRISM (Recommended) @@ -95,7 +95,7 @@ Additionally, you need: - **Cardano Wallet:** A configured Cardano wallet for submitting operations to the blockchain - **Cardano Network Sources:** Connectivity to the Cardano network (mainnet, preprod, or testnet). This might be a Cardano relay node or a DBSync instance -For detailed instructions on deploying and running NeoPRISM in standalone mode, see the [Running NeoPRISM](/docs/documentation/learn/components/neoprism/running-neoprism) documentation. +For detailed instructions on deploying and running NeoPRISM in standalone mode, see the [Running NeoPRISM](/documentation/learn/advanced-explainers/neoprism/running-neoprism) documentation. ## Migration Guide diff --git a/documentation/developers/cloud-agent/secrets-storage.md b/documentation/develop/cloud-agent/secrets-storage.md similarity index 100% rename from documentation/developers/cloud-agent/secrets-storage.md rename to documentation/develop/cloud-agent/secrets-storage.md diff --git a/documentation/developers/cloud-agent/troubleshooting&considerations.md b/documentation/develop/cloud-agent/troubleshooting&considerations.md similarity index 100% rename from documentation/developers/cloud-agent/troubleshooting&considerations.md rename to documentation/develop/cloud-agent/troubleshooting&considerations.md diff --git a/documentation/developers/cloud-agent/vdr.md b/documentation/develop/cloud-agent/vdr.md similarity index 100% rename from documentation/developers/cloud-agent/vdr.md rename to documentation/develop/cloud-agent/vdr.md diff --git a/documentation/developers/quick-start.md b/documentation/develop/quick-start.md similarity index 89% rename from documentation/developers/quick-start.md rename to documentation/develop/quick-start.md index dd80470e09..94f262e976 100644 --- a/documentation/developers/quick-start.md +++ b/documentation/develop/quick-start.md @@ -6,57 +6,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Quick Start Guide -## Introduction into Self Sovereign Identity (SSI) -[Self-sovereign identity (SSI)](/documentation/learn/glossary/#self-sovereign-identity) is complex. This Quick Start Guide explains the fundamental concepts to get up and running with Hyperledger Identus. This guide will familiarize you with the general concepts and how to create [decentralized identifiers (DIDs)](/documentation/learn/glossary/#decentralized-identifier), issue credentials, make connections, and verify credentials with [verifiable presentations](/documentation/learn/glossary/#verifiable-presentation). Refer to the Concepts and Components sections for a more in-depth explanation. - -The trust triangle is the most basic process for conveying trust in the digital world. There are three roles in an SSI ecosystem: [Holders](/documentation/learn/glossary/#holder), [Issuers](/documentation/learn/glossary/#issuer), and [Verifiers](/documentation/learn/glossary/#verifier). - -![Component Diagram](/img/trust-triangle.png) - -Holders can be any entity, such as individuals, organizations, and digital or physical things. They will hold [verifiable credentials (VCs)](/documentation/learn/glossary/#verifiable-credential) and use a verifiable presentation to share their VCs. - -Issuers can also be any entity that makes [claims](/documentation/learn/glossary/#claim) about an [entity](/documentation/learn/glossary/#entity). These claims are attestations, or evidence of something, about the Holder. As an example, an insurance company would provide proof of valid insurance. - -Verifiers are the [relying party](/documentation/learn/glossary/#relying-party) in the triangle. They will request information from the Holder, such as proof of insurance, and the Holder will use a verifiable presentation to share the appropriate VCs with the Verifier. The Holder's digital signature, the issuer DID get verified, and the contents therein to ensure nothing has been tampered with. - - - -## Hyperledger Identus flow -The diagram details how the concepts fit alongside the Identus components in a typical SSI interaction. - -![Component Diagram](/img/component-diagram.png) - - - -## An overview of Hyperledger Identus components -Identus consists of core libraries that facilitate typical SSI interactions between [Issuers](/documentation/learn/glossary/#issuer), [Holders](/documentation/learn/glossary/#holder), and [Verifiers](/documentation/learn/glossary/#verifier). - - -### A Cloud Agent -A Cloud Agent can issue, hold, and verify [verifiable credentials (VCs)](/documentation/learn/glossary/#verifiable-credential) for any entity and manage [decentralized identifiers (DIDs)](/documentation/learn/glossary/#decentralized-identifier) and DID-based connections. The Cloud Agent has an easy-to-use REST API to enable easy integration into any solution and uses [DIDComm V2](/documentation/learn/glossary/#didcomm) as a messaging protocol for Cloud Agent-to-Cloud Agent communication. - -It is maintained as an open source through the [Hyperledger Identus](https://www.hyperledger.org/projects/identus). - -More in depth documentation about [Cloud Agent](/documentation/learn/glossary/#cloud-agent) can be found [here](/home/identus/cloud-agent/overview). - - - -### Wallet SDKs -[Wallet SDKs](/documentation/learn/glossary/#wallet-sdk) for web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests. They are typically used in applications that allow identity holders to interact with issuers and verifiers. - -More in-depth documentation about the different Wallet SDKs can be found here ([TypeScript](https://hyperledger-identus.github.io/docs/sdk-ts/sdk/), [Swift](https://hyperledger-identus.github.io/sdk-swift/documentation/edgeagentsdk/), [KMP](https://hyperledger-identus.github.io/sdk-kmp/)) - - - -### Mediator -[Mediators](/documentation/learn/glossary/#mediator) are for storing and relaying messages between Cloud Agents and Wallet SDKs. They act as a proxy that remains connected to the network and receives any message, credential, or proof request on behalf of the Wallet SDKs (which can be offline occasionally). - -More in-depth documentation about Mediator can be found [here](/home/identus/mediator). - -#### Node for a Verifiable Data Registry (VDR) -To issue and verify VCs to and from DIDs, we need a [Verifiable Data Registry (VDR)](/documentation/learn/glossary/#verifiable-data-registry) that is globally resolvable and always on. In Identus's case, it is `prism-node`, [anchoring](/documentation/learn/glossary/#anchoring) key information required for issuance and verification on the Distributed Ledger. - - ## Pre-Requisites diff --git a/documentation/developers/sidebar.ts b/documentation/develop/sidebar.ts similarity index 97% rename from documentation/developers/sidebar.ts rename to documentation/develop/sidebar.ts index 03416dd623..d44971657e 100644 --- a/documentation/developers/sidebar.ts +++ b/documentation/develop/sidebar.ts @@ -26,7 +26,7 @@ const converted = tutorialsSidebar const sidebar: SidebarsConfig[keyof SidebarsConfig] = [ { type: 'doc', - id: 'documentation/developers/README', + id: 'documentation/develop/README', className: 'hidden-sidebar-item', }, { @@ -157,13 +157,13 @@ const sidebar: SidebarsConfig[keyof SidebarsConfig] = [ id: 'cloud-agent/docs/docusaurus/index' }, items: [ - 'documentation/developers/quick-start', + 'documentation/develop/quick-start', ...converted ] }, { type: 'autogenerated', - dirName: 'documentation/developers/cloud-agent', + dirName: 'documentation/develop/cloud-agent', }, ] }, diff --git a/documentation/learn/README.md b/documentation/learn/README.md index a643d420b7..148570ec5e 100644 --- a/documentation/learn/README.md +++ b/documentation/learn/README.md @@ -1,25 +1,15 @@ ---- -id: README -title: Introduction -sidebar_position: 1 -sidebar_class_name: hidden-sidebar-item ---- +# About Hyperledger Identus +Identity is about access. It is the key that unlocks doors we wish to enter. To stream movies, we need access to get into the virtual theater. Today, we do that by having an account with a streaming service, which authenticates us into the lobby. -# Introduction +We need authorization to enter the theater to watch the movie, which requires a service plan. Which selection will determine whether we can watch in standard, high definition, or 4k. -Hyperledger Identus is a comprehensive toolset that provides the necessary infrastructure for decentralized identity systems. It operates as a layer-2 blockchain solution, using a distributed ledger as a [verifiable data registry (VDR)](./concepts/glossary#verifiable-data-registry). This innovative toolset facilitates the creation and management of decentralized identifiers (DIDs) and supports the issuance, updating, and revocation of verifiable credentials. With this technology, users can securely and efficiently manage their digital identities while ensuring the integrity and authenticity of their credentials. +This example is repeatable across all interactions: banking, insurance, online services, shopping, investing, education, traveling, driving, etc. Identity may be the most essential thing we undervalue in our lives. We use it to physically and digitally access goods and services locally and globally. -Hyperledger Identus is deeply rooted in the concept of [self-sovereign identity (SSI)](./concepts/glossary#self-sovereign-identity), a powerful feature that empowers users to control their identity and personal information. With SSI, users can selectively disclose their data using asymmetric cryptography, giving them full control over their digital identity. +## Self-Sovereign Identity (SSI) +[Self-sovereign identity](/documentation/learn/glossary/#self-sovereign-identity) introduces new concepts that flip the existing identity models. The control shifts from the central authorities to the edges, with individuals. SSI is a set of principles that leverage decentralized identity technology. Sovrin compiled a list of the principles in an easy-to-digest format, available [here](https://sovrin.org/principles-of-ssi/). -The documentation herein will explain the following: +The World Wide Web Consortium (W3C) organization has been setting the standards for the Internet as we know it. Similarly, they are also working on next-generation technologies such as decentralized identity. In July 2022, the W3C approved the DID specification to become a [recommendation](https://www.w3.org/press-releases/2022/did-rec/). -* Decentralized identity concepts -* How Hyperledger Identus works -* Hyperledger Identus Quick Start Guide +The W3C has compiled a list in addition to the specifications for all DID methods available [here](https://www.w3.org/TR/did-spec-registries/). -## Supported Standards -* W3C DID Specification -* DIDComm v2 -* W3C VC-JWT -* Hyperledger Anoncreds -* OpenID for Verifiable Credential Issuance +For a deep dive into the DID specification itself, the W3C standard is [here](https://www.w3.org/TR/did-core/). diff --git a/documentation/learn/components/_category_.json b/documentation/learn/advanced-explainers/_category_.json similarity index 75% rename from documentation/learn/components/_category_.json rename to documentation/learn/advanced-explainers/_category_.json index 68dc8491d2..bdb5fc0782 100644 --- a/documentation/learn/components/_category_.json +++ b/documentation/learn/advanced-explainers/_category_.json @@ -1,11 +1,11 @@ { - "label": "Components", + "label": "Advanced explainers", "position": 3, "collapsed": false, "collapsible": false, "link": { "type": "generated-index", - "title": "Components", + "title": "Advanced explainers", "description": "Technical reference documentation including ADRs, specifications, and API details." } } \ No newline at end of file diff --git a/documentation/learn/components/cloud-agent/README.md b/documentation/learn/advanced-explainers/cloud-agent/README.md similarity index 96% rename from documentation/learn/components/cloud-agent/README.md rename to documentation/learn/advanced-explainers/cloud-agent/README.md index c3568cda50..57556d4db5 100644 --- a/documentation/learn/components/cloud-agent/README.md +++ b/documentation/learn/advanced-explainers/cloud-agent/README.md @@ -79,3 +79,8 @@ This document provides an overview of the Cloud Agent feature set. This document | [0434-out-of-band-protocol](https://github.com/hyperledger/aries-rfcs/blob/main/features/0434-outofband/README.md) | :white_check_mark: | | [0453-issue-credential-protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0453-issue-credential-v2) | :white_check_mark: | | [0453-present-proof-protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0454-present-proof-v2) | :white_check_mark: | + +## Related Tutorials + +- [Quick Start Guide](/documentation/develop/quick-start.md) - Get started with Cloud Agent deployment and credential flows +- [Cloud Agent Tutorials](/cloud-agent/docs/docusaurus/index.md) - Complete tutorials for connections, DIDs, credentials, and multi-tenancy diff --git a/documentation/learn/components/cloud-agent/_category_.json b/documentation/learn/advanced-explainers/cloud-agent/_category_.json similarity index 100% rename from documentation/learn/components/cloud-agent/_category_.json rename to documentation/learn/advanced-explainers/cloud-agent/_category_.json diff --git a/documentation/learn/components/cloud-agent/multi-tenancy.md b/documentation/learn/advanced-explainers/cloud-agent/multi-tenancy.md similarity index 94% rename from documentation/learn/components/cloud-agent/multi-tenancy.md rename to documentation/learn/advanced-explainers/cloud-agent/multi-tenancy.md index 79883e0c16..0835b1504a 100644 --- a/documentation/learn/components/cloud-agent/multi-tenancy.md +++ b/documentation/learn/advanced-explainers/cloud-agent/multi-tenancy.md @@ -76,3 +76,8 @@ graph TB; Entity(Entity) -->|Uses| AuthMethod(Authentication Method) end ``` + +## Related Tutorials + +- [Tenant Onboarding](/cloud-agent/docs/docusaurus/multitenancy/tenant-onboarding) - Set up multi-tenant infrastructure +- [Tenant Onboarding with External IAM](/cloud-agent/docs/docusaurus/multitenancy/tenant-onboarding-ext-iam) - Integrate with Keycloak for JWT authentication diff --git a/documentation/learn/components/did-prism/README.md b/documentation/learn/advanced-explainers/did-prism/README.md similarity index 92% rename from documentation/learn/components/did-prism/README.md rename to documentation/learn/advanced-explainers/did-prism/README.md index beb2d96e8a..8454376c4f 100644 --- a/documentation/learn/components/did-prism/README.md +++ b/documentation/learn/advanced-explainers/did-prism/README.md @@ -40,7 +40,7 @@ The publicly available NeoPRISM can be used to resolve PRISM DIDs and retrieve t The instance of NeoPRISM for the PRISM DIDs published in the Cardano mainnet is: [https://neoprism.patlo.dev/resolver](https://neoprism.patlo.dev/resolver) -For more details on integrating NeoPRISM with the Cloud Agent, see the [NeoPRISM documentation](/docs/documentation/learn/components/neoprism/). +For more details on integrating NeoPRISM with the Cloud Agent, see the [NeoPRISM documentation](/documentation/learn/advanced-explainers/neoprism/). ### PRISM Indexer @@ -77,3 +77,10 @@ Its fetchs the all PRISM events from one DID from the Prism-VDR Github repos and A instance of this tool can be found in [did.fmgp.app](https://did.fmgp.app/#/resolver/did:prism:00592a141a4c2bcb7a6aa691750511e2e9b048231820125e15ab70b12a210aae). Its capable of resolving some DID methods including the `did:prism`. + +## Related Tutorials + +- [Create DIDs](/cloud-agent/docs/docusaurus/dids/create) - Create Cloud Agent-managed DIDs +- [Publish DIDs](/cloud-agent/docs/docusaurus/dids/publish) - Publish DIDs to the ledger +- [Update DIDs](/cloud-agent/docs/docusaurus/dids/update) - Update existing DIDs +- [Deactivate DIDs](/cloud-agent/docs/docusaurus/dids/deactivate) - Deactivate DIDs when no longer needed diff --git a/documentation/learn/components/did-prism/_category_.json b/documentation/learn/advanced-explainers/did-prism/_category_.json similarity index 100% rename from documentation/learn/components/did-prism/_category_.json rename to documentation/learn/advanced-explainers/did-prism/_category_.json diff --git a/documentation/learn/components/did-prism/did-prism-resolver-sdk.md b/documentation/learn/advanced-explainers/did-prism/did-prism-resolver-sdk.md similarity index 100% rename from documentation/learn/components/did-prism/did-prism-resolver-sdk.md rename to documentation/learn/advanced-explainers/did-prism/did-prism-resolver-sdk.md diff --git a/documentation/learn/components/mediator.md b/documentation/learn/advanced-explainers/mediator.md similarity index 100% rename from documentation/learn/components/mediator.md rename to documentation/learn/advanced-explainers/mediator.md diff --git a/documentation/learn/components/neoprism/README.md b/documentation/learn/advanced-explainers/neoprism/README.md similarity index 100% rename from documentation/learn/components/neoprism/README.md rename to documentation/learn/advanced-explainers/neoprism/README.md diff --git a/documentation/learn/components/neoprism/_category_.json b/documentation/learn/advanced-explainers/neoprism/_category_.json similarity index 100% rename from documentation/learn/components/neoprism/_category_.json rename to documentation/learn/advanced-explainers/neoprism/_category_.json diff --git a/documentation/learn/components/neoprism/running-neoprism.md b/documentation/learn/advanced-explainers/neoprism/running-neoprism.md similarity index 100% rename from documentation/learn/components/neoprism/running-neoprism.md rename to documentation/learn/advanced-explainers/neoprism/running-neoprism.md diff --git a/documentation/learn/components/prism-node/README.md b/documentation/learn/advanced-explainers/prism-node/README.md similarity index 100% rename from documentation/learn/components/prism-node/README.md rename to documentation/learn/advanced-explainers/prism-node/README.md diff --git a/documentation/learn/components/prism-node/_category_.json b/documentation/learn/advanced-explainers/prism-node/_category_.json similarity index 100% rename from documentation/learn/components/prism-node/_category_.json rename to documentation/learn/advanced-explainers/prism-node/_category_.json diff --git a/documentation/learn/components/prism-node/running-node.md b/documentation/learn/advanced-explainers/prism-node/running-node.md similarity index 99% rename from documentation/learn/components/prism-node/running-node.md rename to documentation/learn/advanced-explainers/prism-node/running-node.md index 27e85cb4b3..a435951669 100644 --- a/documentation/learn/components/prism-node/running-node.md +++ b/documentation/learn/advanced-explainers/prism-node/running-node.md @@ -4,10 +4,6 @@ The Node is a level 2 proxy on top of the Cardano blockchain responsible for publishing, resolving, updating, and deactivating DIDs. It exposes a gRPC API to perform all the operations above. -:::note -This documentation will not describe the gRPC API itself. -::: - The Identus cloud Agent communicates with the Node, with all operations conducted through it. The following documentation will provide a high-level overview of how the Node functions and explain its usage, including the environment variables required and how to deploy it to the Cardano mainnet and testnet. ## Node components @@ -141,4 +137,4 @@ Node DB is a simple PostgreSQL database. Cardano wallet is an application that communicates with the Cardano network; it functions as a server that you can start and connect to either the mainnet or testnet. You must provide the Node runnable's host and port as environment variables. -DB-sync is an application responsible for syncing the Cardano blockchain with a PostgreSQL database. It would help if you used it to sync with either the mainnet or testnet and must provide the database host with port, database name, and credentials as environment variables to the Node runnable. \ No newline at end of file +DB-sync is an application responsible for syncing the Cardano blockchain with a PostgreSQL database. It would help if you used it to sync with either the mainnet or testnet and must provide the database host with port, database name, and credentials as environment variables to the Node runnable. diff --git a/documentation/learn/basic-concepts.md b/documentation/learn/basic-concepts.md new file mode 100644 index 0000000000..bd546c87b1 --- /dev/null +++ b/documentation/learn/basic-concepts.md @@ -0,0 +1,430 @@ +# Basic concepts + +This section covers the basics of decentralized identity and explains how Identus functions. +Learning outcomes: + +* Discover why identity is important +* Understand the main components and how they interact +* Explore multi-tenancy features +* See how these ideas work together in real-world situations. + +## 1. Why identity matters {#1-why-identity-matters} + +Identity is about access. It is the key that unlocks doors we wish to enter. To stream movies, we need access to the virtual theater. Today, we do that by having an account with a streaming service, which authenticates us into the lobby. + +We need authorization to access a streaming service, which requires a subscription plan. The type of plan determines whether we can watch content in standard, high definition, or 4K resolution. + +This example is repeatable across all interactions, including banking, insurance, online services, shopping, investing, education, traveling, driving, and many more. Identity may be the most essential thing we undervalue in our lives. We use it to access goods and services both physically and digitally, locally and globally. + +### The challenge with current identity systems {#the-challenge-with-current-identity-systems} + +* Control – organizations control identity data instead of individuals +* Privacy – multiple parties collect and store personal information +* Security – hackers target centralized databases to steal data +* Flexibility – users struggle to move identity data between services +* Portability – credentials fail to work across different platforms. + +### Self-sovereign identity {#self-sovereign-identity} + +[Self-sovereign identity](/documentation/learn/glossary/#self-sovereign-identity) directly addresses the challenges above. Instead of organizations holding control, SSI shifts power to individuals. Decentralized identity technology gives people ownership of their identity data, improves privacy, strengthens security, and enables portability across platforms. Sovrin has compiled [a clear overview of SSI principles](https://sovrin.org/principles-of-ssi/). + +### How SSI compares to traditional identity frameworks {#how-ssi-compares-to-traditional-identity-frameworks} + +* Control – in traditional systems, organizations control data. With SSI, individuals own and manage their identity data +* Privacy – traditional models force all-or-nothing data sharing. SSI lets users share only the minimum required information +* Interoperability – platform-specific credentials limit usability. SSI credentials work across different platforms and services +* Security – centralized databases remain vulnerable to breaches. SSI uses cryptographic proofs that make credentials tamper-evident +* Availability – traditional verification depends on service providers. SSI removes this dependency through decentralized verification. + +### Industry standards {#industry-standards} + +The World Wide Web Consortium (W3C) has been setting the standards for the internet as we know it. Similarly, they are also working on next-generation technologies such as decentralized identity. In July 2022, the W3C approved the DID specification to become a [recommendation](https://www.w3.org/press-releases/2022/did-rec/). + +The W3C has compiled a comprehensive registry of all DID methods available in its [DID specification registries](https://www.w3.org/TR/did-spec-registries/). + +For a deep dive into the DID specification itself, see the [W3C DID Core specification](https://www.w3.org/TR/did-core/). + +### Real-world applications {#real-world-applications} + +| Application area | Use case | Key benefit | +| :---- | :---- | :---- | +| **Education** | Tamper-proof diplomas and certificates | Eliminates fraud such as educational misrepresentation | +| **Professional** | Verifiable professional qualifications | Instant verification | +| **Healthcare** | Secure, portable medical information | Patient data integrity | +| **Financial** | Simplified KYC processes | Reduced onboarding time, reusable KYC credentials | +| **Supply chain** | Product authenticity and provenance tracking | Combat counterfeiting | +| **Government** | Digital citizenship and voting systems | Enhanced civic participation, voting system | + +--- + +## 2. How Identus works {#2-how-identus-works} + +Identus enables secure, decentralized identity interactions through a simple but powerful trust model. Understanding this model is key to building effective identity solutions. + +### The trust triangle {#the-trust-triangle} + +The trust triangle is the most basic process for conveying trust in the digital world. There are three roles in the SSI ecosystem – holders, issuers, and verifiers. + +![Trust Triangle diagram](/img/trust-triangle.png) + +### Holders {#holders} + +**Holders** can be any entity, such as individuals, organizations, or digital or physical things. They hold verifiable credentials (VCs) and use verifiable presentations to share their VCs when needed. + +**Example**: Alice holds a university degree credential and a driver's license credential in her digital wallet. + +### Issuers {#issuers} + +**Issuers** can also be any entity that makes claims about another entity. These claims are attestations, or evidence of something, about the holder. Issuers create and sign verifiable credentials. + +**Example**: A university issues a degree credential to Alice, and the driver licensing authority issues a driver’s license credential to Alice. + +### Verifiers {#verifiers} + +**Verifiers** are the relying party in the triangle. They request information from the holder, such as proof of education, and the holder uses a verifiable presentation to share the appropriate VCs with the verifier. The holder's digital signature and the issuer’s DID are verified to ensure nothing has been tampered with. + +**Example**: An employer requests proof of Alice's degree. Alice creates a verifiable presentation containing her university credentials and shares it with the employer. + +### How it works {#how-it-works} + +Identus comprises core libraries that facilitate typical SSI interactions among issuers, holders, and verifiers. + +![Identus component diagram](/img/component-diagram.png) + +**Identus component capabilities** + +The Identus ecosystem consists of three core components, each serving distinct functions in the decentralized identity infrastructure: + +* **Cloud agent** provides comprehensive server-side identity operations, enabling organizations to issue and verify credentials, manage decentralized identifiers, establish secure connections between parties, and support multi-tenant deployments for scalable enterprise use. + +* **Wallet SDKs** deliver client-side credential management capabilities for mobile and web applications, allowing users to securely store their VCs, create presentations for verification requests, manage cryptographic keys, and handle encrypted DIDComm messaging with other parties. + + +* **The mediator** acts as a message routing proxy, ensuring reliable communication in the decentralized ecosystem. It routes and stores messages between parties, enables offline message delivery for mobile devices, and provides privacy-preserving message forwarding without exposing communication patterns. + +For more information, refer to the [Advanced explainers](/category/advanced-explainers). + +**Typical interaction flow** + +| Phase | Actor | Action | Outcome | +| :---- | :---- | :---- | :---- | +| **Setup** | Issuer | Sets up the Cloud agent and creates a DID | Ready to issue credentials | +| **Setup** | Holder | Installs the wallet app with the SDK | Ready to receive credentials | +| **Setup** | Verifier | Sets up the Cloud agent and creates a DID | Ready to verify credentials | +| **Connection** | Issuer | Generates a connection invitation | QR code or link created | +| **Connection** | Holder | Scans the QR code or clicks the link | Connection request sent | +| **Connection** | System | Establishes a secure DIDComm connection | Parties can communicate securely | +| **Issuance** | Issuer | Creates a credential offer | Offer sent to the holder | +| **Issuance** | Holder | Receives and accepts the offer | Verifiable credential obtained | +| **Issuance** | System | Stores the credential securely | Credential ready for use | +| **Verification** | Verifier | Requests proof of attributes | Proof request sent | +| **Verification** | Holder | Creates a verifiable presentation | Presentation sent to verifier | +| **Verification** | Verifier | Cryptographically verifies presentation | Trust decision made | + +## 3. Features and benefits {#3-features-and-benefits} + +Identus includes a range of features that strengthen security, safeguard privacy, and ensure a resilient and reliable architecture. + +| Security layer | Feature | Description | +| :---- | :---- | :---- | +| **Cryptographic** | Digital signatures | Issuers digitally sign all credentials | +| **Cryptographic** | Ownership proofs | Holders prove ownership through cryptographic proofs | +| **Cryptographic** | Encrypted messaging | Communications use encrypted DIDComm messaging | +| **Cryptographic** | Secure key management | Keys managed in secure hardware or software enclaves | +| **Privacy** | Selective disclosure | Share only required attributes | +| **Privacy** | Zero-knowledge proofs | Prove statements without revealing underlying data | +| **Privacy** | Unlinkable presentations | Prevent correlation across verifiers | +| **Privacy** | Minimal data sharing | Verifiers see only what they need | +| **Architecture** | No single point of failure | Distributed system design | +| **Architecture** | Offline operations | Works offline for many operations | +| **Architecture** | Issuer independence | No dependency on issuer for verification | +| **Architecture** | Censorship resistance | Resistant to censorship and service interruptions | + +### Benefits for different roles {#benefits-for-different-roles} + +Identus provides distinct advantages for each participant in the SSI ecosystem: + +* **Issuers** benefit from tamper-evident credentials, automated verification processes, and comprehensive audit trails, resulting in reduced fraud, lower operational costs, and an enhanced customer experience. +* **Holders** gain complete data ownership and control, portable credentials across platforms, and enhanced privacy protection, resulting in greater convenience, improved security, and reduced unnecessary information sharing. +* **Verifiers** enjoy instant verification capabilities, access to trusted information, and easy system integration, which translates to lower compliance costs, reduced liability, and simplified system architecture. + +Now that you've learned about the core concepts of identity, the trust triangle, and how Identus components work together, you can explore multi-tenancy features and discover how to implement these concepts in real-world scenarios. + +## 4. Multi-tenancy {#4-multi-tenancy} + +Multi-tenancy is a fundamental capability of the Identus toolset designed to provide secure and efficient identity and credential management for diverse users and organizations. It enables the platform to serve multiple tenants while ensuring the logical isolation of their assets. + +**Key benefits** + +| Benefit | Description | Business impact | +| :---- | :---- | :---- | +| **Scalability** | Platform scales effortlessly for growing users and organizations | Supports business growth without infrastructure overhaul | +| **Resource efficiency** | Optimizes resource utilization through infrastructure sharing | Enhanced cost-effectiveness and reduced operational overhead | +| **Data isolation** | Complete separation of tenant data (DIDs, VCs, keys, connections) | Preserves data privacy and security across multiple tenants | +| **Enhanced collaboration** | Shared wallets enable collaboration while maintaining data segregation | Supports complex organizational workflows | +| **Granular control** | Administrators control resources and permissions per entity | Fine-tuned security and access management | + +### Roles in multi-tenancy {#roles-in-multi-tenancy} + +Multi-tenancy enables multiple users or systems to utilize the Cloud Agent within a shared instance, enhancing resource utilization while maintaining the separation of each tenant's resources. Understanding different roles in multi-tenancy is essential for the secure and efficient operation of the Cloud agent. + +**Administrator** +The administrator's primary responsibilities include setting up, allocating, and managing tenant resources. Administrators have elevated privileges within the system, enabling them to create, modify, or delete multi-tenant resources, including entities, wallets, and authentication methods. They play a critical role in tenant management but typically don't participate in everyday interactions. + +**Tenant** +Tenants are users or systems engaged in everyday interactions. They have representation via a resource called an entity, which uses a wallet as a container for the assets they own. Tenants can only view the assets within the wallet assigned to their entity. To access the system, they need an authentication method provided by the administrator. + +### Concepts {#concepts} + +**Wallet** +A wallet is a central component of Identus' multi-tenancy model. It serves as a container for storing and managing a tenant's DIDs, connections, VCs, keys, and other related items. Wallets are logically isolated to ensure that the data associated with one entity remains separate and secure from others. + +**Entity** +An entity represents a user or any other identity within the Identus platform. Each entity owns a wallet, making it the primary entity for managing and interacting with its digital credentials and assets. Entities can also share wallets, allowing for the collaborative use of resources. + +**Authentication method** +Each entity is associated with an authentication method, which serves as a secure means of verifying the identity and access rights of the entity. This method ensures the entity's identity is authenticated during interactions with the platform, enhancing security. + +**Logical isolation** +Logical isolation is a core principle of Identus' multi-tenancy model. It ensures that one entity's digital assets, transactions, and data are logically separated from those of others, maintaining the highest level of data privacy and security. + +**Shared wallets** +Identus' multi-tenancy capabilities enable the sharing of wallets across multiple entities. This feature facilitates collaborative work and resource sharing while preserving data isolation within the shared wallet. The entity can own only one wallet. Sharing it with other entities is possible, but multiple entities cannot own it. + +**Tenant management** +Tenant management is the process of onboarding, provisioning, and managing entities and wallets within the Identus platform. Administrators can configure each entity's permissions, resources, and access control, ensuring efficient and secure multi-tenancy operations. + +### Getting started with multi-tenancy {#getting-started-with-multi-tenancy} + +Multi-tenancy requires implementation planning to configure the Cloud agent with multi-tenancy enabled. The system supports various authentication methods, including API keys, JWT tokens, and third-party identity providers. + +For detailed implementation guidance, refer to the [multi-tenancy tutorials](/cloud-agent/docs/docusaurus/multitenancy/tenant-onboarding). + +## 5. Common use cases {#5-common-use-cases} + +Identus enables a wide range of identity and credential applications across various industries. Understanding these use cases helps you identify opportunities to implement decentralized identity solutions in your organization. + +### Education sector {#education-sector} + +**Digital diplomas and certificates** +Universities and other educational institutions can issue tamper-proof, verifiable diplomas and certificates that students own and control. + +**Benefits**: + +* Elimination of fraudulent credentials +* Reduction in verification time from weeks to seconds +* Enablement of global portability of educational achievements +* Lowering of administrative costs for institutions. + +**Example implementation**: a university issues blockchain-anchored degree credentials to graduates. Employers can instantly verify the authenticity without contacting the university. + +**Continuing education tracking** +Professional development and certification programs can create portable learning records that follow learners throughout their careers. + +**Benefits**: + +* Comprehensive professional development history +* Cross-platform recognition of achievements +* Automated compliance tracking +* Simplified certification renewal processes. + +### Healthcare {#healthcare} + +**Medical records portability** +Patients can own and control their medical records, selectively sharing information with healthcare providers while maintaining privacy. + +**Benefits**: + +* Improved care coordination between providers +* Patient control over sensitive health data +* Reduced medical errors from incomplete records +* Emergency access to critical health information. + +**Example implementation**: a patient holds verifiable health credentials, including vaccination status, allergies, and medical history. They can selectively share relevant information with new medical practitioners or emergency responders. + +**Professional licensing** +Medical boards can issue digital licenses that healthcare professionals can present for verification across jurisdictions. + +**Benefits**: + +* Simplified credentialing for multi-state practice +* Real-time license status verification +* Reduced administrative burden on healthcare systems +* Enhanced patient safety through verified practitioner credentials. + +### Financial services {#financial-services} + +**Know-Your-Customer (KYC) optimization** +Financial institutions can streamline customer onboarding by accepting VCs instead of requiring document collection. + +**Benefits**: + +* Faster account opening processes +* Reduced compliance costs +* Enhanced customer experience +* Improved fraud prevention. + +**Example implementation**: a customer uses government-issued digital identity credentials to open a bank account instantly, without submitting physical documents. + +**Credit and lending** +Verifiable financial credentials can enable portable credit histories and alternative lending models. + +**Benefits**: + +* Access to credit for underbanked populations +* Portable credit history across financial institutions +* Reduced risk through verified income and employment data +* Faster loan approval processes. + +### Supply chain and logistics {#supply-chain-and-logistics} + +**Product authenticity** +Manufacturers can create verifiable product credentials that prove authenticity and track provenance throughout the supply chain. + +**Benefits**: + +* Combat counterfeit goods +* Enable consumer verification of product origins +* Simplify regulatory compliance +* Support sustainability and ethical sourcing claims. + +**Example implementation**: a luxury goods manufacturer embeds VCs in its products, allowing consumers to verify authenticity. + +**Shipping and customs** +VCs can streamline international trade by providing trusted documentation for customs and border control. + +**Benefits**: + +* Faster customs clearance +* Reduced paperwork and manual verification +* Enhanced security through cryptographic proofs +* Improved trade compliance. + +### Employment and HR {#employment-and-hr} + +**Professional qualifications** +Professional organizations can issue VCs for licenses, certifications, and memberships that employers can instantly verify. + +**Benefits**: + +* Streamlined hiring processes +* Reduced credential fraud +* Portable professional qualifications +* Automated compliance verification. + +**Employee background checks** +VCs can simplify background check processes by providing trusted, verified information about education, employment history, and certifications. + +**Benefits**: + +* Faster hiring decisions +* Reduced the cost of background verification +* Enhanced privacy for job candidates +* Improved accuracy of verification data. + +### Government and civic services {#government-and-civic-services} + +**Digital citizenship** +Governments can issue digital identity credentials that citizens use to access services, vote, and interact with public agencies. + +**Benefits**: + +* Improved access to government services +* Reduced identity fraud in public programs +* Enhanced privacy in civic participation +* Streamlined service delivery. + +**Immigration and travel** +Verifiable travel documents and immigration credentials can simplify border control and international travel. + +**Benefits**: + +* Faster border processing +* Enhanced security through cryptographic verification +* Reduced document fraud +* Improved traveler experience. + +### Professional services {#professional-services} + +**Legal credentials** +Bar associations and legal organizations can issue VCs for attorney licensing and specializations. + +**Benefits**: + +* Instant verification of legal qualifications +* Simplified bar admission across jurisdictions +* Enhanced client confidence +* Reduced regulatory compliance costs. + +**Consulting and expertise verification** +Professional consultants can maintain verifiable portfolios of their qualifications, project experience, and client testimonials. + +**Benefits**: + +* Enhanced credibility with potential clients +* Simplified proposal and bidding processes +* Portable professional reputation +* Improved matching of expertise to opportunities. + +### Technology and the internet of things (IoT) {#technology-and-the-internet-of-things-(iot)} + +**Device identity and certification** +IoT devices can hold VCs that prove their identity, security compliance, and operational parameters. + +**Benefits**: + +* Enhanced IoT security through device authentication +* Simplified device lifecycle management +* Trusted communication between devices +* Compliance with security and safety standards. + + +**Software and API credentials** +Software applications and APIs can use VCs for authentication and access control. + +**Benefits**: + +* Enhanced application security +* Simplified service-to-service authentication +* Portable API access across platforms +* Improved audit trails for system access. + +### Implementation considerations {#implementation-considerations} + +When planning a use case implementation, consider: + +**Technical requirements** + +* Integration with existing systems +* Performance and scalability needs +* Security and privacy requirements +* Compliance with industry regulations. + +**Stakeholder alignment** + +* Benefits for all participants in the ecosystem +* Change management and adoption strategies +* Governance and policy frameworks +* Interoperability with other systems. + + +**Business model** + +* Cost distribution among participants +* Revenue models and value creation +* Risk mitigation strategies +* Success metrics and measurement. + +### Recommended approach to getting started {#recommended-approach-to-getting-started} + +To implement these use cases: + +1. **Identify your scenario**: map your specific requirements to these proven use case patterns +2. **Design the ecosystem**: clearly define issuers, holders, and verifiers in your implementation +3. **Plan integration**: choose appropriate Identus components based on your technical and business needs +4. **Build a pilot**: start with a limited scope to prove value and refine the approach +5. **Scale systematically**: expand to full implementation based on pilot learnings and user feedback. + +These use cases demonstrate that decentralized identity isn't just a technical improvement. It's a fundamental enhancement to how people and organizations interact in digital systems. The shift from institutional trust to cryptographic proof creates new possibilities for privacy, security, and user empowerment, potentially transforming entire industries. + +For technical implementation guidance, explore the [Advanced explainers](/category/advanced-explainers) and tutorial content. diff --git a/documentation/learn/identity.md b/documentation/learn/identity.md deleted file mode 100644 index fe61b2f6ce..0000000000 --- a/documentation/learn/identity.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Why Identity -Identity is about access. It is the key that unlocks doors we wish to enter. To stream movies, we need access to get into the virtual theater. Today, we do that by having an account with a streaming service, which authenticates us into the lobby. - -We need authorization to enter the theater to watch the movie, which requires a service plan. Which selection will determine whether we can watch in standard, high definition, or 4k. - -This example is repeatable across all interactions: banking, insurance, online services, shopping, investing, education, traveling, driving, etc. Identity may be the most essential thing we undervalue in our lives. We use it to physically and digitally access goods and services locally and globally. - -## Self-Sovereign Identity (SSI) -[SSI](https://github.com/input-output-hk/atala-prism-docs/blob/doc-fixes/docs/concepts/glossary/#self-sovereign-identity) introduces new concepts that flip the existing identity models. The control shifts from the central authorities to the edges, with individuals. SSI is a set of principles that leverage decentralized identity technology. Sovrin compiled a list of the principles in an easy-to-digest format, available [here](https://sovrin.org/principles-of-ssi/). - -The World Wide Web Consortium (W3C) organization has been setting the standards for the Internet as we know it. Similarly, they are also working on next-generation technologies such as decentralized identity. In July 2022, the W3C approved the DID specification to become a [recommendation](https://www.w3.org/press-releases/2022/did-rec/). - -The W3C has compiled a list in addition to the specifications for all DID methods available [here](https://www.w3.org/TR/did-spec-registries/). - -For a deep dive into the DID specification itself, the W3C standard is [here](https://www.w3.org/TR/did-core/). diff --git a/documentation/learn/sidebar.ts b/documentation/learn/sidebar.ts index 30d5121426..4fb4da16ac 100644 --- a/documentation/learn/sidebar.ts +++ b/documentation/learn/sidebar.ts @@ -7,24 +7,27 @@ const sidebar: SidebarsConfig[keyof SidebarsConfig] = [ { type: 'doc', id: 'documentation/learn/README', - className: 'hidden-sidebar-item', }, { type: 'doc', - id: 'documentation/learn/identity', + id: 'documentation/learn/what-is-hyperledger-identus', + }, + { + type: 'doc', + id: 'documentation/learn/basic-concepts', }, { type: 'category', - label: 'Components', + label: 'Advanced explainers', link: { type: 'generated-index', - title: 'Cloud Agent', - description: 'Cloud Agent' + title: 'Advanced explainers', + description: 'Technical deep-dive documentation for Identus components' }, items: [ { type: 'autogenerated', - dirName: 'documentation/learn/components', + dirName: 'documentation/learn/advanced-explainers', }, ] @@ -35,4 +38,4 @@ const sidebar: SidebarsConfig[keyof SidebarsConfig] = [ }, ] -export default sidebar \ No newline at end of file +export default sidebar diff --git a/documentation/learn/what-is-hyperledger-identus.md b/documentation/learn/what-is-hyperledger-identus.md new file mode 100644 index 0000000000..998b5c7abb --- /dev/null +++ b/documentation/learn/what-is-hyperledger-identus.md @@ -0,0 +1,37 @@ +# What is Hyperledger Identus + +Hyperledger Identus (henceforth, Identus) is an application platform that provides a comprehensive and innovative toolset for building decentralized identity systems, using a distributed ledger as a verifiable data registry (VDR). This toolset facilitates the creation and management of decentralized identifiers (DIDs) and supports the issuance, updating, and revocation of verifiable credentials. With this technology, users can securely and efficiently manage their digital identities while ensuring the integrity and authenticity of their credentials. + +Identus is built upon Self-sovereign identity (SSI) principles, empowering users to selectively disclose their data. With SSI, users retain full control of their digital identity. + +**Supported standards** + +Identus is built on industry-standard protocols and specifications to ensure interoperability and compliance with the broader SSI ecosystem: + +* W3C DID Specification +* DIDComm v2 +* W3C VC-JWT +* Hyperledger Anoncreds +* OpenID for Verifiable Credential Issuance. + +## What you'll learn {#what-you'll-learn} + +This Learn section will guide you through understanding Identus, from fundamental concepts to advanced implementations. + +**Learning path overview** + +Begin with the **Basic concepts** section to understand the fundamental principles of decentralized identity. Then explore the **Advanced explainers** for a deeper exploration of the ecosystem components. + +The content assumes basic familiarity with digital identity concepts but explains all SSI-specific terminology. Follow the links to the glossary for detailed definitions throughout the documentation. + +| Level | Section | What you'll get | +| :---- | :---- | :---- | +| Basic | Why identity matters | The role of identity, challenges with current systems, and SSI principles | +| Basic | How Identus works | Trust triangle, core components, interaction flow, security model | +| Basic | Features and benefits | Features that strengthen security, safeguard privacy, and ensure a resilient and reliable architecture, along with benefits for different roles | +| Basic | Multi-tenancy | Why it matters, roles, concepts (wallet, entity, auth), getting started | +| Basic | Common use cases | Domain examples (education, finance, healthcare, government), success factors | +| Advanced | Ecosystem components overview | The tools that work together to establish a framework for implementing decentralized identity solutions | +| Advanced | Cloud agent architecture | Capabilities, DID methods, protocols, security, interoperability | +| Advanced | Wallet SDK integration | Platforms (Swift, TS, KMP), core features, integration patterns | +| Advanced | Mediator services | Role in DIDComm, offline delivery, test suite coverage, roadmap | diff --git a/documentation/reference/README.md b/documentation/reference/README.md index 2795a2f7d3..36bbf10420 100644 --- a/documentation/reference/README.md +++ b/documentation/reference/README.md @@ -63,10 +63,10 @@ ADRs help developers understand the "why" behind technical choices and maintain ## Quick Links -- [Getting Started Guide](../developers/quick-start.md) +- [Getting Started Guide](../develop/quick-start.md) - [Learn Identus Concepts](../learn/README.md) -- [Developer Tutorials](../developers/README.md) +- [Developer Tutorials](../develop/README.md) ## Contributing -Found an issue or want to improve the documentation? Contributions are welcome! Visit our [GitHub repository](https://github.com/hyperledger-identus) to get involved. \ No newline at end of file +Found an issue or want to improve the documentation? Contributions are welcome! Visit our [GitHub repository](https://github.com/hyperledger-identus) to get involved. diff --git a/sidebars.ts b/sidebars.ts index 5b915ab2c1..cdbf851568 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -1,7 +1,7 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; import learnSidebar from './documentation/learn/sidebar'; -import developersSidebar from './documentation/developers/sidebar'; +import developersSidebar from './documentation/develop/sidebar'; import referenceSidebar from './documentation/reference/sidebar'; const sidebars: SidebarsConfig = { diff --git a/src/config/headerMenu.ts b/src/config/headerMenu.ts index 5424b7e30d..ac6daab698 100644 --- a/src/config/headerMenu.ts +++ b/src/config/headerMenu.ts @@ -9,10 +9,10 @@ export const headerMenu: NavbarItem[] = [ label: 'Learn', }, { - to: '/documentation/developers/', + to: '/documentation/develop/', position: 'left', - activeBaseRegex: `/documentation/developers/`, - label: 'Developers', + activeBaseRegex: `/documentation/develop/`, + label: 'Develop', }, { to: '/documentation/reference/', diff --git a/src/config/presets.ts b/src/config/presets.ts index 47e96011a8..842b2e865d 100644 --- a/src/config/presets.ts +++ b/src/config/presets.ts @@ -5,7 +5,7 @@ import type * as OpenApiPlugin from 'docusaurus-plugin-openapi-docs'; * * Each Repository will distribute the documentation in the same way we are implementing now. * docs/learning - * docs/developers + * docs/develop * docs/reference * * Each folder can have a sidebar.ts to define the sidebar items, but its not required. @@ -21,12 +21,12 @@ const remarkLinkFixerRules = [ { type: 'prefix', from: '/home/quick-start', - to: '/documentation/developers/quick-start', + to: '/documentation/develop/quick-start', }, { type: 'prefix', from: '/home/identus/cloud-agent/overview', - to: '/documentation/learn/components/cloud-agent', + to: '/documentation/learn/advanced-explainers/cloud-agent', }, { type: 'prefix', @@ -41,7 +41,7 @@ const remarkLinkFixerRules = [ { type: 'prefix', from: '/home/identus/mediator', - to: '/documentation/learn/components/mediator', + to: '/documentation/learn/advanced-explainers/mediator', }, { type: 'prefix', @@ -101,8 +101,8 @@ export const presets: PresetConfig[] = [ 'SECURITY.md', 'documentation/adrs/**/*.md', 'documentation/adrs/**/*.mdx', - 'documentation/developers/**/*.md', - 'documentation/developers/**/*.mdx', + 'documentation/develop/**/*.md', + 'documentation/develop/**/*.mdx', 'documentation/learn/**/*.md', 'documentation/learn/**/*.mdx', 'documentation/reference/**/*.md', @@ -113,7 +113,7 @@ export const presets: PresetConfig[] = [ * * Each Repository will distribute the documentation in the same way we are implementing now. * docs/learning - * docs/developers + * docs/develop * docs/reference * * Each folder can have a sidebar.ts to define the sidebar items, but its not required.