diff --git a/SUMMARY.md b/SUMMARY.md index cafcc59..c977cf1 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,21 +3,23 @@ ## ℹ️ Getting Started * [Product Overview](README.md) +* [1️⃣ 1️⃣ Design your Solution](getting-started/design/README.md) + * [Establish Parties in Trust Ecosystem](getting-started/design/establish-parties.md) + * [Design your Trust Infrastructure](getting-started/design/trust-infrastructure/README.md) + * [Roots of Trust](getting-started/design/trust-infrastructure/roots-of-trust.md) + * [Verifiable Accreditations](getting-started/design/trust-infrastructure/verifiable-accreditations.md) + * [Accreditation and Issuance Policies](getting-started/design/trust-infrastructure/policies.md) + * [Data Models](getting-started/design/trust-infrastructure/data-models.md) + * [Governance Framework](getting-started/design/trust-infrastructure/governance-framework.md) + * [Establish Schemas for Accreditations and Credentials](getting-started/design/schemas.md) + * [Choose a Credential Issuance Provider](getting-started/design/choose-a-credential-issuance-provider.md) + * [Monetise your solution](getting-started/design/monetise-your-solution.md) * [Get started with cheqd Studio](getting-started/studio/README.md) * [👉 Set up your account](getting-started/studio/set-up-account.md) * [🔄 Advanced configuration options](getting-started/studio/advanced.md) ## 🟢 Start using cheqd -* [1️⃣ Design your Solution](studio/design/README.md) - * [Establish Parties in Trust Ecosystem](studio/design/establish-parties.md) - * [Design your Trust Infrastructure](studio/design/trust-infrastructure/README.md) - * [Roots of Trust](studio/design/trust-infrastructure/roots-of-trust.md) - * [Verifiable Accreditations](studio/design/trust-infrastructure/verifiable-accreditations.md) - * [Accreditation and Issuance Policies](studio/design/trust-infrastructure/policies.md) - * [Data Models](studio/design/trust-infrastructure/data-models.md) - * [Governance Framework](studio/design/trust-infrastructure/governance-framework.md) - * [Establish Schemas for Accreditations and Credentials](studio/design/schemas.md) * [🆔 Create DIDs and Identity keys](studio/dids/README.md) * [Create Issuer DID](studio/dids/create-did.md) * [Create Identity Keys and Subject DIDs](studio/dids/create-subject-did.md) diff --git a/studio/design/README.md b/getting-started/design/README.md similarity index 100% rename from studio/design/README.md rename to getting-started/design/README.md diff --git a/getting-started/design/choose-a-credential-issuance-provider.md b/getting-started/design/choose-a-credential-issuance-provider.md new file mode 100644 index 0000000..3f02264 --- /dev/null +++ b/getting-started/design/choose-a-credential-issuance-provider.md @@ -0,0 +1,2 @@ +# Choose a Credential Issuance Provider + diff --git a/studio/design/establish-parties.md b/getting-started/design/establish-parties.md similarity index 91% rename from studio/design/establish-parties.md rename to getting-started/design/establish-parties.md index dea7f19..6e00009 100644 --- a/studio/design/establish-parties.md +++ b/getting-started/design/establish-parties.md @@ -7,6 +7,7 @@ By completing this subsection, you will: * Identify all actors and map out their roles and relationships. * Define the rules and policies of your use case. * Define the legal identities involved. +* Understand how to set up DIDs for your entities * Define accreditations issued by the Trusted Accreditation Organisation. \ diff --git a/getting-started/design/monetise-your-solution.md b/getting-started/design/monetise-your-solution.md new file mode 100644 index 0000000..cb6a08c --- /dev/null +++ b/getting-started/design/monetise-your-solution.md @@ -0,0 +1,2 @@ +# Monetise your solution + diff --git a/studio/design/schemas.md b/getting-started/design/schemas.md similarity index 100% rename from studio/design/schemas.md rename to getting-started/design/schemas.md diff --git a/studio/design/trust-infrastructure/README.md b/getting-started/design/trust-infrastructure/README.md similarity index 100% rename from studio/design/trust-infrastructure/README.md rename to getting-started/design/trust-infrastructure/README.md diff --git a/studio/design/trust-infrastructure/data-models.md b/getting-started/design/trust-infrastructure/data-models.md similarity index 100% rename from studio/design/trust-infrastructure/data-models.md rename to getting-started/design/trust-infrastructure/data-models.md diff --git a/studio/design/trust-infrastructure/governance-framework.md b/getting-started/design/trust-infrastructure/governance-framework.md similarity index 100% rename from studio/design/trust-infrastructure/governance-framework.md rename to getting-started/design/trust-infrastructure/governance-framework.md diff --git a/studio/design/trust-infrastructure/policies.md b/getting-started/design/trust-infrastructure/policies.md similarity index 100% rename from studio/design/trust-infrastructure/policies.md rename to getting-started/design/trust-infrastructure/policies.md diff --git a/studio/design/trust-infrastructure/roots-of-trust.md b/getting-started/design/trust-infrastructure/roots-of-trust.md similarity index 100% rename from studio/design/trust-infrastructure/roots-of-trust.md rename to getting-started/design/trust-infrastructure/roots-of-trust.md diff --git a/studio/design/trust-infrastructure/verifiable-accreditations.md b/getting-started/design/trust-infrastructure/verifiable-accreditations.md similarity index 100% rename from studio/design/trust-infrastructure/verifiable-accreditations.md rename to getting-started/design/trust-infrastructure/verifiable-accreditations.md diff --git a/studio/did-linked-resources/README.md b/studio/did-linked-resources/README.md index 671e331..c315ccd 100644 --- a/studio/did-linked-resources/README.md +++ b/studio/did-linked-resources/README.md @@ -2,7 +2,7 @@ description: Create digital Resources linked to cheqd DIDs on-ledger --- -# ↕ Create DID-Linked Resources +# ↕️ Create DID-Linked Resources **"DID-Linked Resources"** are identified with a [`did:cheqd` Decentralized Identifier](../../architecture/adr-list/adr-002-did-linked-resources.md) with a [Universally Unique Identifier (UUID)](https://www.uuidgenerator.net/) that acts as a permanently-accessible link to fetch the resources from the cheqd ledger. We refer to this as the "**resource ID**". Through the "**resource ID**" or a set of DID URL query parameters, applications are able to persistently access a digital resource on the cheqd network. @@ -16,4 +16,4 @@ description: Create digital Resources linked to cheqd DIDs on-ledger Below are a list of alternatives for creating cheqd DID-Linked Resources. -
DID RegistrarSimple setup for building cheqd DIDs into existing applications using REST APIs, building into the Universal Registrar.did-registrar
Veramo SDK PluginThe Veramo SDK Plugin is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.veramo-plugin
Aries Framework JavaScriptAries Framework JavaScript is an SDK which supports ZKCreds (AnonCreds) natively with cheqd support. credo.md
cheqd Cosmos CLICosmos-native CLI for creating transactions on cheqd. Should be used for testing purposes only.
+
DID RegistrarSimple setup for building cheqd DIDs into existing applications using REST APIs, building into the Universal Registrar.did-registrar
Veramo SDK PluginThe Veramo SDK Plugin is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.veramo-plugin
CredoCredo is an SDK which supports the European Architecture and Reference Framework (ARF) standards as well as AnonCreds with full cheqd support for DIDs. credo.md
cheqd Cosmos CLICosmos-native CLI for creating transactions on cheqd. Should be used for testing purposes only.
diff --git a/studio/payments/learn/README.md b/studio/payments/learn/README.md index d4d66ed..751202e 100644 --- a/studio/payments/learn/README.md +++ b/studio/payments/learn/README.md @@ -12,8 +12,8 @@ Build your knowledge about how cheqd's Credential Payment model works, including ## Get started -Using the Veramo SDK Plugin for cheqd, you can get started setting up your encrypted Status Lists with Access Control Conditions below: +Using cheqd Studio, you can get started setting up your encrypted Status Lists with Access Control Conditions below: -
Charge for Status ListSet your payment conditions and encrypt a Status List 2021 Resource.charge.md
Issue Credential with Encrypted Status ListIssue a Verifiable Credential referencing an encrypted Status List in the Credential body.issue-paid-credential.md
Verifier pays IssuerPay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.verifier-pays-issuer.md
+
Charge for Status ListSet your payment conditions and encrypt a Status List 2021 Resource.charge.md
Issue Credential with Encrypted Status ListIssue a Verifiable Credential referencing an encrypted Status List in the Credential body.issue-credential.md
Verifier pays IssuerPay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.verifier-pays-issuer.md
t diff --git a/studio/payments/learn/access-control-conditions.md b/studio/payments/learn/access-control-conditions.md index c4292a6..f08b3f0 100644 --- a/studio/payments/learn/access-control-conditions.md +++ b/studio/payments/learn/access-control-conditions.md @@ -80,6 +80,6 @@ Once an Access Control Condition has been set, the decryption keys are sharded b ## Get started -Using the Veramo SDK Plugin for cheqd, you can get started setting up your encrypted Status Lists with Access Control Conditions below: +Using cheqd Studio, you can get started setting up your encrypted Status Lists with Access Control Conditions below: -
Charge for Status ListSet your payment conditions and encrypt a Status List 2021 Resource.charge.md
Issue Credential with Encrypted Status ListIssue a Verifiable Credential referencing an encrypted Status List in the Credential body.issue-paid-credential.md
Verifier pays IssuerPay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.verifier-pays-issuer.md
+
Charge for Status ListSet your payment conditions and encrypt a Status List 2021 Resource.charge.md
Issue Credential with Encrypted Status ListIssue a Verifiable Credential referencing an encrypted Status List in the Credential body.issue-credential.md
Verifier pays IssuerPay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.verifier-pays-issuer.md
diff --git a/studio/trust-registries/README.md b/studio/trust-registries/README.md index 2506a12..b6a7457 100644 --- a/studio/trust-registries/README.md +++ b/studio/trust-registries/README.md @@ -14,7 +14,7 @@ cheqd supports multiple Trust Registry Data Models, using its flexible DID and D Learn about a data model below: -
Verifiable Accreditation Trust Chain ModelBuild our Trust Registry solution using DIDs and DID-Linked Resources based on the EBSI Trust Chain model.cheqd_logo_card.jpg
OpenID Federation on cheqdDeploy an OpenID Federation ecosystem on cheqd, using DIDs and DID-Linked Resources for Entity IDs and Entity Statements.Contact usOpenIDforWebsite.png
+
Verifiable Accreditation Trust Chain ModelBuild our Trust Registry solution using DIDs and DID-Linked Resources based on the EBSI Trust Chain model.cheqd_logo_card.jpgverifiable-accreditation-trust-chain-model.md
OpenID Federation on cheqdDeploy an OpenID Federation ecosystem on cheqd, using DIDs and DID-Linked Resources for Entity IDs and Entity Statements.Contact usOpenIDforWebsite.png
## Get started diff --git a/studio/trust-registries/create-accreditation.md b/studio/trust-registries/create-accreditation.md index 4aa96d9..d364abb 100644 --- a/studio/trust-registries/create-accreditation.md +++ b/studio/trust-registries/create-accreditation.md @@ -83,7 +83,7 @@ For a trusted ecosystem, these attestations are required to trace the legitimacy
-Verifiable Accreditation to Attest Example +Example of Verifiable Accreditation to Attest ```json { @@ -164,7 +164,7 @@ SGVsbG8sIHdvcmxk DID-Linked Resources are grouped by having identical **names** and **types**. This means if you want to create a new version of the same Resource, you will need to **specify the same name and type in the following request**. -For Verifiable Accreditations, the "type" MUST be either: **`"VerifiableAccreditationToAccredit"`** or **`"VerifiableAccreditationToAccredit"`** +For Verifiable Accreditations, the "type" MUST be either: **`"VerifiableAccreditationToAccredit"`** or **`"VerifiableAccreditationToAttest"`** For example: