docs: quick start guide polishing (#157)

* Update docusaurus.config.js - changing logo Signed-off-by: Pete Vielhaber <[email protected]> * Update quick-start.md - Minor style/grammar changes Signed-off-by: Pete Vielhaber <[email protected]> * Update README.md - Minor styling changes Signed-off-by: Pete Vielhaber <[email protected]> * Update MAINTAINERS.md Signed-off-by: Pete Vielhaber <[email protected]> * Update glossary.md - cleanup Signed-off-by: Pete Vielhaber <[email protected]> * Update glossary.md Signed-off-by: Pete Vielhaber <[email protected]> --------- Signed-off-by: Pete Vielhaber <[email protected]>
hyperledger-identus · Sep 4, 2024 · bc23b50 · bc23b50
1 parent 96805ae
commit bc23b50
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 86 deletions.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,3 +1,3 @@
 # Mainteiners
 
-For information about the Maintainers of this repository, please see the Hyperledger Identus repository’s [MAINTAINERS.md](https://github.com/hyperledger/identus/blob/main/MAINTAINERS.md) file.
+For information about the Maintainers of this repository, refer to the Hyperledger Identus repository’s [MAINTAINERS.md](https://github.com/hyperledger/identus/blob/main/MAINTAINERS.md) file.
diff --git a/README.md b/README.md
@@ -3,36 +3,27 @@
 This website is built using [Docusaurus 2](https://docusaurus.io/).
 
 # Structure
-
-The `documentation` folder is split into the following parts:
-* `docs`
-* `tutorials`
-* `sdk`
-* `api`
+* docs
+* tutorials
+* sdk
+* api
 
 ## `docs`: general documentation
-
-`documentation/docs` is a general documentation directory for:
 * Getting started guides
 * SSI and Identus concepts
 * Identus architecture and components description
 
 ## `tutorials`: general Identus tutorials
-
-`documentation/tutorials`  directory assigned to contain all tutorials about essential topics and protocols Identus is supported, for example:
 * Credential issuance
 * Verification
 * DIDs
 * etc.
 
 ## `sdk`: SDKs documentation
-
-`documentation/sdk` is a special directory for SDK documentation, user guides, and examples. There are two subfolders:
-* `enterprise-sdk`: for what we call now "Enterprise SDK"
-* `wallet-sdk`: for what we call now "Wallet SDK"
+* enterprise-sdk
+* wallet-sdk
 
 ## `api`: autogenerated docs from OpenAPI specs
-
 `documentation/api` directory contains auto-generated documentation for RestAPI endpoints provided by Identus executables, it's auto-generated and should not be added manually.
 
 ## Installation

diff --git a/documentation/docs/concepts/glossary.md b/documentation/docs/concepts/glossary.md
@@ -1,25 +1,25 @@
 # Glossary
 
 ## A
-### access control
+### Access control
 Access control mechanisms define how tenants/entities can access and interact with their data and resources and control who can access them. 
 It helps enforce security and privacy policies in a multi-tenant environment.
 
-### anchoring
+### Anchoring
 The act of anchoring is tying to something that is trusted by assumption. Usually some sort of an entity with authority.
 
 ### Administrator
 An administrator is a role who oversees the agent and releated resources, including tenant, Edge Agent management, or external services. Admistrator typically does not participate in day-to-day SSI interactions.
 
 
 ## C
-### claim
+### Claim
 An assertion made about a [subject](#did-subject).
 
 ### Cloud Agent
 The Cloud Agent is a scaleable, easy-to-use, robust, and W3C standards-based agent that provides self-sovereign identity (SSI) services to build products and solutions based on it. The Cloud Agent exposes REST API for integration with any programming language.
 
-### controller
+### Controller
 See [DID Controller](#did-controller).
 
 ### Connection Protocol
@@ -28,26 +28,26 @@ The protocol provides endpoints for creating and managing connections, as well a
 ### connection invitation
 An invitation from one entity to another to establish a connection.
 
-### connection request
+### Connection request
 A request to establish a connection.
 
-### credential schema
+### Credential schema
 A data template for verifiable credentials (VCs). It contains claims of the VCs, credential schema author, type, name, version, and proof of authorship.
 
-### credential offer
+### Credential offer
 An Issuer sends a request to the Holder to accept a verifiable credential.
 
-### credential request
+### Credential request
 When the Holder accepts or rejects a credential offer, a credential request is created from it.
 
 
 
 ## D
-### decentralized identifier
+### Decentralized Identifier (DID)
 A globally unique persistent identifier that does not require a centralized registration authority and is often cryptographically generated. All DIDs use distributed ledger technology (DLT) or some other decentralized network.
 
 ### DID
-See [decentralized identifier](#decentralized-identifer)
+See [decentralized identifier](#decentralized-identifer-(did))
 
 ### DIDComm
 A set of secure, standards-based communications protocols to establish and manage trusted, peer-to-peer connections and interactions between DIDs in a transport-agnostic and interoperable manner.
@@ -65,32 +65,36 @@ The DID method defines how to implement a specific DID method schema. The specif
 The process for retrieving a [DID document](#did-document).
 
 ### DID subject
-The entity is identified by a [DID](#decentralized-identifer) and described by a [DID documents](#did-document). Anything can be a DID subject: person, group, organization, physical thing, digital thing, etc.
+The entity is identified by a [DID](#decentralized-identifer-(did)) and described by a [DID documents](#did-document). Anything can be a DID subject: person, group, organization, physical thing, digital thing, etc.
 
-### distributed ledger technology (DLT)
+### Distributed Ledger Technology (DLT)
 A distributed database or ledger establishes confidence for the participants to rely on the data recorded. Typically these databases use nodes and a consensus protocol to confirm the order of cryptographically signed transactions. Linking the transactions over time creates a historical ledger that is effectively immutable.
 
 
 
 ## E
-### endpoints
+### Endpoints
 A network address at which services operate on behalf of a [DID subject](#did-subject).
 
-### entity
+### Entity
 An `entity,` in the context of the Identus platform, is an identity representing a user or system. 
 Each entity possesses an Edge Agent and is associated with an authentication method. 
 Entities are crucial for secure and verifiable transactions within the SSI ecosystem.
 
+### Edge Agent SDK
+For use with web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests.
 
+### Edge Agent
+A Edge Agent can perform DID operations, like create, update, and deactivate. It also enables management of verifiable credentials, and communications.
 
 ## G
-### governance framework
+### Governance framework
 See [Trust Framework](#trust-framework)
 
 
 
 ## H
-### holder 
+### Holder 
 An entity will take on this role by possessing one or more [verifiable credentials](#verifiable-credentials) and generating [verifiable presentations](#verifiable-presentations). Also takes the role of a prover when presenting verifiable credentials for verification.
 
 
@@ -105,16 +109,16 @@ A suite of products that provides infrastructure for decentralized identity.
 ### IDP
 An Identity Provider (IDP) is a centralized service that manages and authenticates user identities, allowing individuals to access multiple applications and services with a single set of credentials. IDPs play a crucial role in Single Sign-On (SSO) systems, simplifying user access management across various platforms and services.
 
-### invitation
+### Invitation
 Sent by the [inviter](#inviter) to the [invitee](#invitee) to request and establish a connection.
 
-### invitee
+### Invitee
 A subject that receives a connection invitation and accepts it by sending a connection request.
 
-### inviter
+### Inviter
 A subject that initiates a connection request by sending a connection invitation.
 
-### issuer
+### Issuer
 An entity that asserts claim(s) about one or more [subjects](#did-subject) then creates a [verifiable credentials](#verifiable-credentials) from these claims and transmits the VC to a holder.
 
 ### Issue Credential Protocol
@@ -126,13 +130,13 @@ Keycloak is an open-source [IAM](#iam) solution that provides authentication, au
 
 
 ## M
-### mediator
+### Mediator
 A mediator participates in agent-to-agent message delivery that the sender must model. It has its keys and will deliver messages only after decrypting an outer envelope to reveal a forward request. Many types of mediators may exist, but two important ones should be widely understood, as they commonly manifest in DID Docs:
 - A service that hosts many cloud agents at a single endpoint to provide herd privacy (an "agency") is a mediator.
 - A cloud-based agent that routes between/among the edges of a sovereign domain is a mediator.
 For a detailed overview of mediators refer to the [RFC0046: Mediators and Relays](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0046-mediators-and-relays).
 
-### mutli-tenancy
+### Mutli-tenancy
 Multi-tenancy is a core capability of the Identus platform, allowing it to serve numerous users/identities while logically isolating their Edge Agent assets. 
 This segregation maintains data privacy and security, enhancing scalability and resource sharing within the SSI ecosystem.
 
@@ -155,10 +159,10 @@ A rich DID method that has no blockchain dependencies. The verifiable data regis
 ### Present Proof Protocol
 The protocol provides endpoints for a Verifier to request new proof presentations from Holder/Provers and for a Holder/Prover to respond to the presentation request using a specific verifiable credential they own.
 
-### proof
+### Proof
 A cryptographic mechanism that proves the information in a [verifiable credential](#verifiable-credentials) or [verifiable presentation](#verifiable-presentation) has not been tampered with. Many types of cryptographic proofs include but are not limited to digital signatures, zero-knowledge proofs, Proofs of Work, and Proofs of Stake.
 
-### proof presentation
+### Proof presentation
 See [verifiable presentation](#verifiable-presentation). Also see [Present Proof Protocol](#present-proof-protocol).
 
 ### Protection API
@@ -167,32 +171,32 @@ The Protection API in User-Managed Access ([UMA](#uma)) is a set of endpoints th
 ### Protection API
 The Protection API in User-Managed Access ([UMA](#uma)) is a set of endpoints that enables resource servers to enforce access policies and protect resources. It provides a mechanism for resource servers to interact with the authorization server to obtain necessary information and permissions, ensuring that access to user-managed resources aligns with the user's specified policies.
 
-### protocol buffer
+### Protocol buffer
 Also known as protobuf.
 
 
 
 ## R
-### relay
+### Relay
 A relay is an entity that passes along agent-to-agent messages depending on the sender's encryption choices. It does not decrypt anything. Relays can change the transport for a message (e.g., accept an HTTP POST, then turn around and emit an email, or accept a Bluetooth transmission, then turn around and transmit something in a message queue). Mix networks like TOR are a type of relay.
 For a detailed overview of relays refer to the [RFC0046: Mediators and Relays](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0046-mediators-and-relays).
 
-### relying party
+### Relying party
 A party that depends on the authenticity of digital signatures.
 
 ### RPT
 Requesting Party Token (RPT) is a concept within the [UMA](#uma) framework. It represents a token obtained by a client application from an authorization server, allowing the client to access protected resources on behalf of the requesting party (user), based on the user's policies and consent.
 
 
 ## S
-### secrets storage
+### Secrets storage
 This component securely stores sensitive information, such as private keys associated with an individual's digital identity, Edge Agent seed, etc.
 Secrets storage plays a crucial role in SSI implementations because it ensures that sensitive information is securely stored and protected against unauthorized access or disclosure
 
 ### SSI
 See [Self-Sovereign Identity](#self-sovereign-identity)
 
-### Self-Sovereign Identity
+### Self-Sovereign Identity (SSI)
 An identity model that shifts control to the edges, focused on security, privacy using public/private key encryption.
 
 
@@ -225,24 +229,17 @@ User-Managed Access (UMA) is an authorization framework that allows users to con
 HashiCorp Vault is a widely used open-source and enterprise-grade solution designed for securely storing, accessing, and managing secrets and sensitive data in modern computing environments.
 It offers a centralized platform for managing cryptographic keys, passwords, API keys, tokens, and other secrets.
 
-### verifiable credential (VC)
+### Verifiable Credential (VC)
 A verifiable credential is a tamper-evident credential that contains one or more claims made by an issuer whose authorship can be cryptographically verified. It is possible to use VCs to create a [verifiable presentation](#verifiable-presentation). Also, the claims in a VC can be about different subjects.
 
-### verifiable data registry
+### Verifiable Data Registry
 A system that mediates the creation and verification of identifiers, keys, and other relevant data.
 
-### verifiable presentation
+### Verifiable Presentation
 Data is derived from one or more [verifiable credentials](#verifiable-credential), issued by issuers, and shared (presented) to a specific verifier. The verifiable presentation is tamper-evident and encoded in a way to trust the authorship of the data after a cryptographic verification. 
 
-### verifier
+### Verifier
 An entity that receives one or more [verifiable credentials](#verifiable-credential) optionally, inside a [verifiable presentation](#verifiable-presentation). Also known as a relying party.
 
 
 
-## W
-### Edge Agent SDK
-For use with web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests.
-
-### Edge Agent
-A Edge Agent can perform DID operations, like create, update, and deactivate. It also enables management of verifiable credentials, and communications.
-