diff --git a/documentation/docs/contact.md b/documentation/docs/contact.md
index 8ca485ea42..ad8f82fa20 100644
--- a/documentation/docs/contact.md
+++ b/documentation/docs/contact.md
@@ -1,6 +1,12 @@
---
title: Contact
sidebar_label: Contact
+description: Get in touch with the project maintainers.
+image: /img/Identity_icon.png
+keywords:
+- Contact
+- GitHub
+- Maintainers
---
TODO: Add ways to contact the maintainers
\ No newline at end of file
diff --git a/documentation/docs/contribute.md b/documentation/docs/contribute.md
index ab5ace28eb..710fc478b6 100644
--- a/documentation/docs/contribute.md
+++ b/documentation/docs/contribute.md
@@ -1,6 +1,14 @@
---
title: Contribute to the project
sidebar_label: Contribute
+description: Contribute to IOTA Identity by joining the Identity initiative, via the projects GitHub repository, documentation, or sharing your knowledge.
+image: /img/Identity_icon.png
+keywords:
+- Contribute
+- GitHub
+- Identity Initiative
+- Documentation
+- Discord
---
**Thanks for thinking about contributing to the project! We have the following ways that you can contribute.**
diff --git a/documentation/docs/intro_ssi.md b/documentation/docs/decentralized_identity.md
similarity index 78%
rename from documentation/docs/intro_ssi.md
rename to documentation/docs/decentralized_identity.md
index 8e60c010a6..8bac03bd3b 100644
--- a/documentation/docs/intro_ssi.md
+++ b/documentation/docs/decentralized_identity.md
@@ -1,9 +1,15 @@
---
-title: Introduction to Decentralized Identity
-sidebar_label: Decentralized Identity
+description: Decentralized identity defines a new method for identity management and authentication by removing centralized aspects.
+image: /img/Identity_icon.png
+keywords:
+- Self Sovereign Identity
+- decentralized
+- Permissionless
+- authentication
---
+# Introduction to Decentralized Identity
-Decentralized Identity or Self Sovereign Identity (SSI) defines a new method for identity management and authentication. It removes the centralized aspects and puts the Identity subject in full control over its own identity. Decentralized identity provides a solution for the increasing amount of database breaches, the lack of trust in any digital setting and the increasingly difficult to comply to privacy legislation, such as GDPR.
+Decentralized Identity or Self Sovereign Identity (SSI) defines a new method for identity management and authentication. It removes the centralized aspects and puts the Identity subject in full control over its own identity. Decentralized identity provides a solution for the increasing amount of database breaches, the lack of trust in any digital setting, and the increasingly difficult to comply to privacy legislation, such as GDPR.
There are three levels of privacy when interacting on the internet: full privacy, verifiable identities and pseudonymity. With full privacy, neither parties, nor observers, can identify the interacting parties. With verifiable identities, parties can trust each other, because they can both provide proof about their identities. With pseudonymity, both parties recognize each other through a pseudonymous identifier. Pseudonymity is the default setting of the internet. However, data harvesting platforms, like
Google and Facebook, can now link these “random” identifiers, though imprecisely, to identities in the real-world. The associated data and insights have become extremely valuable to advertising agencies, product developers, and numerous local and global businesses.
@@ -14,9 +20,13 @@ With digital identity, the user can decide what information to share and with wh
-### Identity for People
+## Identity for People
-> IOTA Identity builds a new internet, without usernames, passwords, endless repeated forums, or uncontrolled data harvesting.
+:::info New internet
+
+IOTA Identity builds a new internet, without usernames, passwords, endless repeated forums, or uncontrolled data harvesting.
+
+:::
Information about one’s life is spread across many locations. Most people have numerous unorganized important documents at home, hundreds of online accounts, and many more online footprints. Through statistical predictive analysis, computer programs can harvest unverified online information sources and create a reasonably accurate profile about our lives. These profiles are accurate enough for targeted advertising and personalized content, but lack the proof and trust for them to be used in business. This results in an antiquated customer experience where we have to submit our age and address for every purchase we make and every account we create. It also inhibits our ability to do many online tasks like requesting and extending licenses or taking out a mortgage.
@@ -26,12 +36,12 @@ IOTA Identity allows a new internet without usernames, passwords, endless repeat
Governmental mechanisms for building digital identities are currently being established throughout Europe and Asia, with demand increasing around the globe. However, they are managed by single entities, and restricted to the governments that created them. By decentralizing a framework for these standards to adapt to, we have a system for intergovernmental verification of individuals and devices. A person’s digital identification will be transferable across borders like a passport. However, it will no longer require the trust of the issuing government due to the digital trust established by the open and auditable system.
-### Identity for Organizations
-
-> IOTA Identity allows organizations to comply with GDPR in a cost efficient and privacy-enabling manner
+## Identity for Organizations
-Many corporations are associated with greed and abuse of power. This reputation stems from the role some have chosen to take within society. Corporations are trusted with our data, but often do not act responsibly. Vulnerability, fix, patch, repeat. In software and systems we have seen this
-cycle repeat. Headlines on data leaks are now an ever-present feature in the news.
+:::info GDPR
+IOTA Identity allows organizations to comply with GDPR in a cost efficient and privacy-enabling manner
+:::
+Many corporations are associated with greed and abuse of power. This reputation stems from the role some have chosen to take within society. Corporations are trusted with our data, but often do not act responsibly. Vulnerability, fix, patch, repeat. In software and systems we have seen this cycle repeat. Headlines on data leaks are now an ever-present feature in the news.
IOTA Identity presents an opportunity for companies to embrace a new role in the ecosystem. Traditional approaches do not provide cost efficient solutions to new legislation like GDPR. IOTA Identity enables organizations to change their processes to comply with the new regulations in a cost efficient and privacy-enabling manner. Features of “Data Protection and Privacy by Design” shift responsibility over Personal Identifiable Information (PII) from organization to customer, and organizations no longer need to store that data. The relationship between customer and organization is also tightened as communication via a third party Identity provider like Google or Facebook is no longer needed.
@@ -39,38 +49,51 @@ Due to Know-Your-Customer (KYC) and Anti-Money Laundering (AML) obligations, com
Organizations that have their own decentralized identities can also combat fraud and increase control over their online brand. Companies can sign invoices and agreements using their decentralized identities. While interacting with the customers, they will also be able to reliably identify themselves.
-### Identity for Things
+## Identity for Things
+
+:::info TRUST
+
+IOTA Identity adds the missing key ingredient for the "Economy of Things": Trust.
-> IOTA Identity adds the missing key ingredient for the "Economy of Things": Trust.
+:::
-With Identity of Things (IDoT) devices are provided with a unique global identity, able to prove many attributes including their capabilities, specifications and authenticity. People, organizations and other devices will only pay devices that can prove their ability to fulfill the required task. This basis of trust prevents fraudulent activity. In addition, by using the IOTA ledger, the progress of the task can be immutably logged. With the combination of the IOTA protocol and the IOTA Identity framework, we can automate the entire interaction between all parties, without requiring predefined trust. The [Industry Marketplace](https://industry.iota.org/) provides a perfect example of how this framework and level of autonomy work.
+With Identity of Things (IDoT) devices are provided with a unique global identity, able to prove many attributes including their capabilities, specifications, and authenticity. People, organizations, and other devices will only pay devices that can prove their ability to fulfill the required task. This basis of trust prevents fraudulent activity. In addition, by using the IOTA ledger, the progress of the task can be immutably logged. With the combination of the IOTA protocol and the IOTA Identity framework, we can automate the entire interaction between all parties, without requiring predefined trust. The [Industry Marketplace](https://industry.iota.org/) provides a perfect example of how this framework and level of autonomy work.
There is a growth in applications that generate Digital Twins for physical devices or objects, such as the Asset Administration Shell (AAS) developed for our Industry Marketplace. Digital twins are online profiles representing a device or object. They provide a virtual state that mirrors reality by emulating the device or object’s physical state through data input sources like sensors. A digital twin is often used to monitor state and execute actions based on the information. Digital twins are only rarely shared outside the associated application and organization due to complexity in sharing and matching profiles. However, empowered with a digital identity, digital twin sharing would become possible. Once data is verifiable and trusted, digital twins can form the basis for the digital
representation of physical devices and objects. This allows other identities to interact with them automatically, and provide services such as predictive maintenance.
Security is a major barrier in advancing technologies that use IoT. Whether it is the smart devices in our own homes, or at a larger scale, the critical infrastructure of organizations and cities, security must be at the core. It is central to any globally-unifying identity solution. By integrating advanced research in cryptography and digital ledgers, and combining it with a scalable access and management system, security will become a core functionality of the systems we build. By using scalable device DIDs, integrating verification and reputation schemes, and allowing for transparent tamper-proof accountability, we begin to understand how we can future-proof the security of our systems, allowing us to start trusting the process, and not the patch.
-### One Framework. Any Identity.
+## One Framework. Any Identity.
-> The IOTA Identity framework serves as the invisible layer of trust for the internet. This framework must be open, scalable and free, so that everyone and everything can enjoy trust as a basic digital right.
+:::info Framework
-With multiple different types of actor requiring an identity protocol, it is a strong proposition to use the same underlying protocol for all of them. This IOTA Identity framework enables anyone or anything to create a digital identity, build an online profile of trust by collecting verifiable credentials, and share them with other actors they interact with. Interaction between people, companies, things and objects becomes seamless. And just as we can trust a person we will also be able to trust a car, or even a luxury coat. Different identities can also be linked together, creating trustworthy relationships, such as ownership of an object. IOTA already provides a protocol that enables these actors to transact value or data with one another. IOTA will now combine identity features into a single platform, creating the base protocol for the next generation of smart applications.
+ The IOTA Identity framework serves as the invisible layer of trust for the internet. This framework must be open, scalable and free, so that everyone and everything can enjoy trust as a basic digital right.
-### Why IOTA?
+:::
-> IOTA is a neutral and free-to-use public infrastructure acting as a trustworthy public commons.
+With multiple different types of actors requiring an identity protocol, it is a strong proposition to use the same underlying protocol for all of them. This IOTA Identity framework enables anyone or anything to create a digital identity, build an online profile of trust by collecting verifiable credentials, and share them with other actors they interact with. Interaction between people, companies, things and objects becomes seamless. And just as we can trust a person we will also be able to trust a car, or even a luxury coat. Different identities can also be linked together, creating trustworthy relationships, such as ownership of an object. IOTA already provides a protocol that enables these actors to transact value or data with one another. IOTA will now combine identity features into a single platform, creating the base protocol for the next generation of smart applications.
+
+## Why IOTA?
+
+:::info Neutral and Free
+
+IOTA is a neutral and free-to-use public infrastructure acting as a trustworthy public commons.
+
+:::
IOTA is a scalable and feeless Distributed Ledger Technology (DLT). Similar to Blockchain technology, IOTA provides an immutable and decentralized ledger that can transact value through the IOTA token. Unlike Blockchain, IOTA uses a non-linear data structure called the Tangle which makes it feeless and vastly more scalable. The Tangle also facilitates feeless transactions of data, such as DID registrations and credential revocations. As a single source of truth and trust in data, the Tangle can provide the trust infrastructure in a highly networked world.
IOTA is uniquely suited for the a single unifying identity implementation. The network is designed for both humans and devices, providing a platform for trusted communication between individuals, organizations and things. The IOTA Foundation’s principles of full transparency, openness and permissionless innovation provide an open and neutral environment:
+
1. **Permissionless & Decentralized**: Unlike a permissioned network such as Hyperledger or Corda, everyone can participate in consensus without being granted access. No party incentivized by profit-making has collective control over the network (unlike all blockchains). This makes IOTA neutral and censorship-resistant.
2. **Public**: Everyone can observe (unless using optional encryption) the transactions in the network. The network is inherently transparent.
3. **Feeless**: All data and value transactions on the network are free. Unlike other DLTs such as Bitcoin or Ethereum, registration and communication of identities can be written to the network without a requirement to purchase a cryptocurrency token.
4. **Open Source**: Everyone can view and contribute to the code.
-5. **Easy to use**: IOTA Identity is inheritantly easier to use due to the lack of fees or requirement to set up an entire private network. In addition, the framework is designed to have a easy to use high-level API, with accesibility to the low-level more complex and more flexible API. Through integration with the Stronghold project, we also provide out-of-the-box security for secrets.
+5. **Easy to use**: IOTA Identity is inherently easier to use due to the lack of fees or requirement to set up an entire private network. In addition, the framework is designed to have a easy to use high-level API, with accessibility to the low-level more complex and more flexible API. Through integration with the Stronghold project, we also provide out-of-the-box security for secrets.
-Data must be immutably stored on a distributed ledger to ensure the decentralized nature of the digital identity protocol. With the network’s continual uptime, credentials are always verifiable without a dependency on the servers of credential issuers. This system also increases individual privacy, because contact with the Issuer is removed from the interaction between Holder and Verifier. Issuers will not be able to track when and how often the Holder uses their credentials. The flexibility afforded of the Tangle means that the digital identity framework remains extendible in the future.
+Data must be immutably stored on a distributed ledger to ensure the decentralized nature of the digital identity protocol. With the network’s continual uptime, credentials are always verifiable without a dependency on the servers of credential issuers. This system also increases individual privacy, because contact with the Issuer is removed from the interaction between Holder and Verifier. Issuers will not be able to track when and how often the Holder uses their credentials. The flexibility afforded of the Tangle means that the digital identity framework remains extendable in the future.
Within the digital identity framework, the Tangle is used for the following functionalities:
1. **Public Key Registry**: The Tangle enables a decentralized public key infrastructure (DPKI) for Issuers using DID standards. This allows Verifiers to verify a signature without a reliance on a centralized server. The DID standard also adds service endpoints, extending the usability of Identities beyond a public key registry, to, for example, registering verifiable credential standards.
-2. **Revocation**: A verifiable credential can be revoked, meaning it will no longer be able to pass verification. The revocation is immutably stored on the Tangle, making sure no Holder can attempt to use their revoked credentials. This is designed to be a simple public key deactivation to guarentee GDPR compliance.
\ No newline at end of file
+2. **Revocation**: A verifiable credential can be revoked, meaning it will no longer be able to pass verification. The revocation is immutably stored on the Tangle, making sure no Holder can attempt to use their revoked credentials. This is designed to be a simple public key deactivation to guarantee GDPR compliance.
\ No newline at end of file
diff --git a/documentation/docs/faq.md b/documentation/docs/faq.md
index 589091f047..9276534b88 100644
--- a/documentation/docs/faq.md
+++ b/documentation/docs/faq.md
@@ -1,6 +1,13 @@
---
title: Frequently Asked Questions
sidebar_label: FAQ
+description: Frequently Asked Question regardging IOTA Identity.
+image: /img/Identity_icon.png
+keywords:
+- FAQ
+- Frequently Asked Question
+- Troubleshooting
+- IOTA Identity
---
TODO: Add list of frequently asked questions and there answers
\ No newline at end of file
diff --git a/documentation/docs/getting-started/advanced/README.md b/documentation/docs/getting-started/advanced/README.md
deleted file mode 100644
index a4ba87ea0d..0000000000
--- a/documentation/docs/getting-started/advanced/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Advanced Concepts Overview
-sidebar_label: Overview
----
-
-TODO: Provide overview of the advanced concepts
\ No newline at end of file
diff --git a/documentation/docs/getting-started/advanced/client.md b/documentation/docs/getting-started/advanced/client.md
index 8db8390e97..3d325dbaf2 100644
--- a/documentation/docs/getting-started/advanced/client.md
+++ b/documentation/docs/getting-started/advanced/client.md
@@ -1,6 +1,11 @@
---
title: IOTA Client
sidebar_label: IOTA Client
+description: Explain what the IOTA Client does and how the features such as ZMQ and promoting should be used.
+image: /img/Identity_icon.png
+keywords:
+- IOTA Client
+- ZMQ
---
TODO: Explain what the IOTA Client does and how the features such as ZMQ and promoting should be used.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/advanced/did_messages.md b/documentation/docs/getting-started/advanced/did_messages.md
index 656c7923c0..c9a2cacc5e 100644
--- a/documentation/docs/getting-started/advanced/did_messages.md
+++ b/documentation/docs/getting-started/advanced/did_messages.md
@@ -1,6 +1,16 @@
---
title: DID Messages
sidebar_label: DID Messages
+description: Learn how IOTA Identity recreates and validates the state from it's origin to the current version using Integration and Differentiation Chains.
+image: /img/Identity_icon.png
+keywords:
+- Diff Chain
+- Differentiation Chain
+- Integration Chain
+- smart contracts
+- Chronicle
+- state
+- stateless
---
TODO: Explain the concept of DID Messages and how they can be used to optimize DID updates.
@@ -9,7 +19,7 @@ TODO: Explain the concept of DID Messages and how they can be used to optimize D
Most DID methods are implemented on a Distributed Ledger Technology (DLT), such as Bitcoin, Ethereum or IOTA. Most common DID implementation on DLTs are based on fit-for-purpose Blockchains that store the state of a DID Document in the ledger, or a general purpose Blockchain that utilize smart contracts to store the state. Updating a DID Document where the state is understood by the network is straightforward. The network can determine if an action is legal and if a cryptographic signature is provided correctly, as it understands the underlying data structure, and can update the state accordingly. The individual state updates, or transactions, can be forgotten.
-The IOTA Tangle is unable to track state or the understand the data structure. Storing the state is neither possible in the ledger, nor via a Smart contract (yet). Therefore, IOTA Identity has to recreate and validate the state from the origin of the Identity to the current version. The process involves querying all the relevant transactions from the Tangle, ordering them, filtering out the transactions that perform illegal actions or have an incorrect signature and then recreate state. As this requires the full history of the Identity, we recommend utilizing [Chronicle](https://github.com/iotaledger/chronicle.rs), an IOTA permanode, which stores the entire history of the Tangle. Further research will be performed to reduce storage requirements for IOTA Identity based applications.
+The IOTA Tangle is unable to track, state, or understand the data structure. Storing the state is neither possible in the ledger, nor via a Smart contract (yet). Therefore, IOTA Identity has to recreate and validate the state from the origin of the Identity to the current version. The process involves querying all the relevant transactions from the Tangle, ordering them, filtering out the transactions that perform illegal actions or have an incorrect signature and then recreate state. As this requires the full history of the Identity, we recommend utilizing [Chronicle](https://github.com/iotaledger/chronicle.rs), an IOTA permanode, which stores the entire history of the Tangle. Further research will be performed to reduce storage requirements for IOTA Identity based applications.
### DID Messages
@@ -17,7 +27,7 @@ Due to this constant need for state recreating, unique performance improvements
The Integration Chain is a chain of transactions that contain full DID Documents. They are unrestricted in what they can add or remove from the DID Document. Every Integration Chain transaction points to a separate new Diff Chain. These Diff Chain transactions only list the changes to a DID Document and are therefore more compact. It is, however, restricted in rotating the signing key, making it fast and easy to validate the transaction.
-Once a new Integration chain transaction is created, it will take all Diff Chain updates and compress them into a new DID Document, essentially combining them all into a single transaction. This reduces the amount of updates that need to be queried and validated tremendously. For example, lets assume every Diff chain contains 100 updates. Then validating a DID that has done 1050 updates, only requires the validation of 10 Integration Chain updates and 40 Diff Chain updates (The latest Diff Chain). We skipped out on 10 Diff Chains each containing 100 updates, and only validated the 10 Integration Chain updates and the last Diff Chain containing 40 updates. If we estimate every update to be on average 1 Kb, we only have to download 50 kb of information and validate it, which is signficantly less then the otherwise 1.025 Mb of information.
+Once a new Integration chain transaction is created, it will take all Diff Chain updates and compress them into a new DID Document, essentially combining them all into a single transaction. This reduces the amount of updates that need to be queried and validated tremendously. For example, lets assume every Diff chain contains 100 updates. Then validating a DID that has done 1050 updates, only requires the validation of 10 Integration Chain updates and 40 Diff Chain updates (The latest Diff Chain). We skipped out on 10 Diff Chains each containing 100 updates, and only validated the 10 Integration Chain updates and the last Diff Chain containing 40 updates. If we estimate every update to be on average 1 Kb, we only have to download 50 kb of information and validate it, which is significantly less than the otherwise 1.025 Mb of information.
The improved performance and ability to handle frequently updated DID Documents is especially beneficial for Verifiable Credential Revocation, by utilizing revocation flags. These concepts will be explained in the Verifiable Credentials and Key Collections sections.
diff --git a/documentation/docs/getting-started/advanced/overview.md b/documentation/docs/getting-started/advanced/overview.md
new file mode 100644
index 0000000000..3ca0522125
--- /dev/null
+++ b/documentation/docs/getting-started/advanced/overview.md
@@ -0,0 +1,11 @@
+---
+title: Advanced Concepts Overview
+sidebar_label: Overview
+description: Provide overview of the advanced concepts
+image: /img/Identity_icon.png
+keywords:
+- advanced
+- concepts
+---
+
+TODO: Provide overview of the advanced concepts
\ No newline at end of file
diff --git a/documentation/docs/getting-started/advanced/signature_schemes.md b/documentation/docs/getting-started/advanced/signature_schemes.md
index 9b2b60d3a5..15826a0ec4 100644
--- a/documentation/docs/getting-started/advanced/signature_schemes.md
+++ b/documentation/docs/getting-started/advanced/signature_schemes.md
@@ -1,6 +1,12 @@
---
title: Signature Schemes
sidebar_label: Signature Schemes
+description: Explain what signature schemes are available and how a new one can be added locally (and to the repo).
+image: /img/Identity_icon.png
+keywords:
+- signature
+- local
+- schemes
---
-TODO: Explain what signature schemes are avaliable and how a new one can be added locally (and to the repo).
\ No newline at end of file
+TODO: Explain what signature schemes are available and how a new one can be added locally (and to the repo).
\ No newline at end of file
diff --git a/documentation/docs/getting-started/advanced/storage_adapter.md b/documentation/docs/getting-started/advanced/storage_adapter.md
index e8cfd8b3d9..adb06fe35f 100644
--- a/documentation/docs/getting-started/advanced/storage_adapter.md
+++ b/documentation/docs/getting-started/advanced/storage_adapter.md
@@ -1,6 +1,12 @@
---
title: Storage Adapter
sidebar_label: Storage Adapter
+description: Explain the need for the storage adapter and how it can used to store account data differently
+image: /img/Identity_icon.png
+keywords:
+- storage adapter
+- account
+- data
---
TODO: Explain the need for the storage adapter and how it can used to store account data differently
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did/create.md b/documentation/docs/getting-started/decentralized_identifiers/create.mdx
similarity index 73%
rename from documentation/docs/getting-started/did/create.md
rename to documentation/docs/getting-started/decentralized_identifiers/create.mdx
index 1037f7028a..2ba44a6bf8 100644
--- a/documentation/docs/getting-started/did/create.md
+++ b/documentation/docs/getting-started/decentralized_identifiers/create.mdx
@@ -1,6 +1,13 @@
---
title: Creating a Decentralized Identity
sidebar_label: Create and Publish
+description: DID Documents and publishing them to the Tangle
+image: /img/Identity_icon.png
+keywords:
+- Documents
+- DID
+- Tangle
+- Publish
---
TODO: Explain DID, DID Documents and publishing them to the Tangle.
diff --git a/documentation/docs/getting-started/decentralized_identifiers/merkle_key_collection.md b/documentation/docs/getting-started/decentralized_identifiers/merkle_key_collection.md
new file mode 100644
index 0000000000..edc0467a3e
--- /dev/null
+++ b/documentation/docs/getting-started/decentralized_identifiers/merkle_key_collection.md
@@ -0,0 +1,11 @@
+---
+title: Merkle Key Collection
+sidebar_label: Merkle Key Collection
+description: Explain why, how to use and how merkle key collections work.
+image: /img/Identity_icon.png
+keywords:
+- Merkle Key Collections
+- DID
+---
+
+TODO: Explain why, how to use and how merkle key collections work.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did/README.md b/documentation/docs/getting-started/decentralized_identifiers/overview.md
similarity index 81%
rename from documentation/docs/getting-started/did/README.md
rename to documentation/docs/getting-started/decentralized_identifiers/overview.md
index 1aaa652f94..1e010b4682 100644
--- a/documentation/docs/getting-started/did/README.md
+++ b/documentation/docs/getting-started/decentralized_identifiers/overview.md
@@ -1,20 +1,28 @@
---
-title: Decentralized Identifiers (DID)
-sidebar_label: Overview
+description: The Decentralized Identifiers (DID) standard from W3C is the fundamental standard that supports the concept of a decentralized digital identity. Explore the basic aspects of the DID standard.
+image: /img/Identity_icon.png
+keywords:
+- public keys
+- Method Specification
+- Decentralized Identifiers
+- overview
+- DLT
---
-The Decentralized Identifiers (DID) standard from W3C is the fundamental standard that supports the concept of a decentralized digital identity. A DID is a unique identifier that contains information that can be resolved to a DID Document. This document contains data such as public keys, enabling the holder to prove ownership over their personal data, but also URIs that link to public information about the identity. This implementation complies to the [DID specifications v1.0 Working](https://www.w3.org/TR/did-core//).
+# Decentralized Identifiers (DID)
-In the IOTA Identity framework, we have implemented the DID standard according to the `iota` DID Method Specification, which can be viewed [here](./specs/iota_did_method_spec.md). We recommend to see the `iota` DID Method Specification as the golden standard for DID on IOTA. Other implementations of DID on IOTA is recommended to follow the `iota` DID Method Specification. However, it is not necassary to implement a novel Method implementation for every project, so feel free to utilize this framework directly.
+The Decentralized Identifiers (DID) standard from W3C is the fundamental standard that supports the concept of a decentralized digital identity. A DID is a unique identifier that contains information that can be resolved to a DID Document. This document contains data such as public keys, enabling the holder to prove ownership over their personal data, but also URIs that link to public information about the identity. This implementation complies to the [DID specifications v1.0 Working](https://www.w3.org/TR/did-core//).
+
+In the IOTA Identity framework, we have implemented the DID standard according to the `iota` [DID Method Specification](./specs/iota_did_method_spec.md). We recommend seeing the `iota` DID Method Specification as the golden standard for DID on IOTA. Other implementations of DID on IOTA are recommended to follow the `iota` DID Method Specification. However, it is not necassary to implement a novel Method implementation for every project, so feel free to utilize this framework directly.
An example of DID conforming to the `iota` method specification:
`did:iota:8dQAzVbbf6FLW9ckwyCBnKmcMGcUV9LYJoXtgQkHcNQy`
-### Chapter overview
+## Chapter Overview
In this chapter we will explain the basic aspects of the DID standard. We will explore the how and why of DID Documents and why IOTA is a very suitable technology to host the DID Documents and the rest of a Self Sovereign Identity Framework.
-### Decentralized Identifiers
+## Decentralized Identifiers
A Decentralized Identifier, or DID, is a unique identifier that is tied to a subject. This subject can be anything, like a person, an organization, an IoT device or even an object. The identifier can be used by the subject to identify themselves through a digital format, providing a basis for online identification. The identifier looks like a set of random characters that includes some prefixes to determine which standard and implementation is used:
@@ -22,7 +30,7 @@ A Decentralized Identifier, or DID, is a unique identifier that is tied to a sub
The World Wide Web Consortium (W3C) is a well-known standardization body that has standardized how DIDs should look like and work. This provides a basis for different technologies that implement the DID standard to achieve interoperability. A full list of all implementations can be found [here.](https://www.w3.org/TR/did-spec-registries/#did-methods) Please keep in mind that unfortuanetly most of these methods are outdated and not maintained.
-### DID Documents
+## DID Documents
The purpose of a DID is to help navigate to a DID Document, which is a document containing more information regarding the identity subject. This document contains data such as public keys, enabling the subject to prove ownership over their personal data, but also URIs that link to public information about the identity.
@@ -44,25 +52,25 @@ Never share your private keys, seeds, passphrases with anyone. Not even IOTA Fou
Services are URIs that point to more information about the identity. This could be something as simple as a website for a organizational identity. These services are publicly avaliable for all to read and should therefore not contain Personal Identifiable Information (PII) in the case of human identities.
-### Why use DIDs?
+## Why use DIDs?
DIDs have some limited use cases. It allows any subject to have a unique identifier, that they can prove ownership off and at the same time provide a way to send them encrypted messages. The Identity is Self Sovereign, meaning the subject is control of when the identity is created, but also destroyed.
DIDs become really interesting in combination with Verifiable Credentials, that will be covered in a later section. In essence, Verifiable Credentials (VCs) are signed statements by trusted third parties about a certain identity. The signer, or Issuer, is referenced by DID and so is the subject, often called the Holder. The Holder can control a copy of this statement and share this with other parties, the Verifiers, that can verify the statement and check which party gave out the statement, without having to ask the Issuer. Instead, they can verify the signature of the Issuer by checking the Issuers DID Document. This whole set up puts Holders back into control over their own data, but also makes the data much more trustworthy as it has become verifiable.
-### Why use IOTA Identity over other implementations?
+## Why use IOTA Identity over other implementations?
-IOTA Identity is a framework to implement Self Sovereign Identities on IOTA. Inheritly, IOTA provides some unique features that have a major impact on the usability of the framework.
+IOTA Identity is a framework to implement Self Sovereign Identities on IOTA. Inherently, IOTA provides some unique features that have a major impact on the usability of the framework.
-#### Feeless
+### Feeless
IOTA is a feeless Distributed Ledger Technology, that means that messages can immutably be stored inside the Tangle at no-cost, nor a requirements of holding any cryptocurrency tokens. That means that SSI applications can directly deploy towards the main network without any problems, as compared to most other SSI solutions running on a test network or having cryptocurrency requirements. This doesn't just make IOTA Identity have predictable costs and prevent issues around cryptocurrency holding taxes and legislation, it also makes it a fair network as anyone would be able to create one or more identities at no costs. The wealth of someone is irrelevant, making it the most inclusive SSI solution.
-#### Ease-of-use
+### Ease-of-use
Without the need for a token, IOTA Identity can directly be used on the main network without having to purchase and manage a cryptocurrency token. In addition, the framework provides easy-to-use APIs that allow both standardized behavior or flexible, yet more complex access. Lastly, IOTA Identity provides a Stronghold solution for managing secrets in a secure manner, without requiring developers to reinvent the security wheel.
-#### General Purpose DLT
+### General Purpose DLT
IOTA is a general purpose DLT as compared to some for-purpose DLTs with restricted use cases. That means that SSI can easily be combined with other DLT features such as payments, data streams, smart contracts and access control. It will no longer be needed to utilize multiple DLT projects alongside each other.
diff --git a/documentation/docs/getting-started/did/resolve.md b/documentation/docs/getting-started/decentralized_identifiers/resolve.md
similarity index 51%
rename from documentation/docs/getting-started/did/resolve.md
rename to documentation/docs/getting-started/decentralized_identifiers/resolve.md
index d62da244eb..5528f7fe5f 100644
--- a/documentation/docs/getting-started/did/resolve.md
+++ b/documentation/docs/getting-started/decentralized_identifiers/resolve.md
@@ -1,6 +1,9 @@
---
title: Resolve an IOTA Identity
sidebar_label: Resolve
+description: Explain how resolving works including arguments.
+image: /img/Identity_icon.png
+keywords:
+- Resolve
---
-
TODO: Explain how resolving works including arguments.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/decentralized_identifiers/update.md b/documentation/docs/getting-started/decentralized_identifiers/update.md
new file mode 100644
index 0000000000..8ab76ce591
--- /dev/null
+++ b/documentation/docs/getting-started/decentralized_identifiers/update.md
@@ -0,0 +1,14 @@
+---
+title: Update DID Documents
+sidebar_label: Update
+description: How DID Documents can be manipulated and how updates should be published.
+image: /img/Identity_icon.png
+keywords:
+- Documents
+- DID
+- Tangle
+- Update
+- Publish
+---
+
+TODO: Explain how DID Documents can be manipulated and how updates should be published.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did/merkle_key_collection.md b/documentation/docs/getting-started/did/merkle_key_collection.md
deleted file mode 100644
index 651a815d8d..0000000000
--- a/documentation/docs/getting-started/did/merkle_key_collection.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Merkle Key Collection
-sidebar_label: Merkle Key Collection
----
-
-TODO: Explain why, how to use and how merkle key collections work.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did/update.md b/documentation/docs/getting-started/did/update.md
deleted file mode 100644
index 7ebf79654b..0000000000
--- a/documentation/docs/getting-started/did/update.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Update DID Documents
-sidebar_label: Update
----
-
-TODO: Explain how DID Documents can be manipulated and how updates should be published.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did_communications/did_comm_messages.md b/documentation/docs/getting-started/did_communications/did_comm_messages.md
new file mode 100644
index 0000000000..be2527532a
--- /dev/null
+++ b/documentation/docs/getting-started/did_communications/did_comm_messages.md
@@ -0,0 +1,12 @@
+---
+title: DID Comm messages
+sidebar_label: DID Comm messages
+description: Explain how to create and verify DID Comm messages
+image: /img/Identity_icon.png
+keywords:
+- communication
+- message
+- Create
+---
+
+TODO: Explain how to create and verify DID Comm messages
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did_communications/overview.md b/documentation/docs/getting-started/did_communications/overview.md
new file mode 100644
index 0000000000..3ce4e69454
--- /dev/null
+++ b/documentation/docs/getting-started/did_communications/overview.md
@@ -0,0 +1,12 @@
+---
+title: DID Communications Overview
+sidebar_label: Overview
+description: Explain the DID Communications standard and what it is useful for
+image: /img/Identity_icon.png
+keywords:
+- communication
+- message
+- standard
+---
+
+TODO: Explain the DID Communications standard and what it is useful for
\ No newline at end of file
diff --git a/documentation/docs/getting-started/did_communications/protocols.md b/documentation/docs/getting-started/did_communications/protocols.md
new file mode 100644
index 0000000000..77d0c88294
--- /dev/null
+++ b/documentation/docs/getting-started/did_communications/protocols.md
@@ -0,0 +1,12 @@
+---
+title: DID Comm Protocols
+sidebar_label: Protocols
+description: Provide an overview of the DID Comm protocols
+image: /img/Identity_icon.png
+keywords:
+- communication
+- communications
+- protocols
+- Create
+---
+TODO: Provide an overview of the DID Comm protocols
\ No newline at end of file
diff --git a/documentation/docs/getting-started/didcomm/README.md b/documentation/docs/getting-started/didcomm/README.md
deleted file mode 100644
index 1603c6d6d8..0000000000
--- a/documentation/docs/getting-started/didcomm/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: DID Communications Overview
-sidebar_label: Overview
----
-
-TODO: Explain the DID Communications standard and what it is useful for
\ No newline at end of file
diff --git a/documentation/docs/getting-started/didcomm/did_comm_messages.md b/documentation/docs/getting-started/didcomm/did_comm_messages.md
deleted file mode 100644
index 7316a0d53d..0000000000
--- a/documentation/docs/getting-started/didcomm/did_comm_messages.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: DID Comm messages
-sidebar_label: DID Comm messages
----
-
-TODO: Explain how to create and verify DID Comm messages
\ No newline at end of file
diff --git a/documentation/docs/getting-started/didcomm/protocols.md b/documentation/docs/getting-started/didcomm/protocols.md
deleted file mode 100644
index 20f0010f0a..0000000000
--- a/documentation/docs/getting-started/didcomm/protocols.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: DID Comm Protocols
-sidebar_label: Protocols
----
-TODO: Provide an overview of the DID Comm protocols
\ No newline at end of file
diff --git a/documentation/docs/getting-started/overview.md b/documentation/docs/getting-started/overview.md
index 22c1057beb..0b411f8e88 100644
--- a/documentation/docs/getting-started/overview.md
+++ b/documentation/docs/getting-started/overview.md
@@ -1,13 +1,18 @@
---
-sidebar_position: 2
-title: Overview
+description: Using IOTA Identity, a new digital identity can be created by anyone or anything at any time by generating a Decentralized Identifier (DID) combined with Verifiable Credentials.
+image: /img/Identity_icon.png
+keywords:
+- Identity
+- verifiable
+- credentials
+- Rust
+- WASM
---
-
# Overview
Using the standards proposed by W3C, this chapter will explain the IOTA Identity implementation. Using this implementation, a new digital identity can be created by anyone or anything at any time. To do so, a Decentralized Identifier (DID) is generated, that serves as a reference to a DID Document. The DID Document contains public keys, and other mechanisms, to enable the subject to prove their association with the DID.
-However a DID alone tells you little about the subject. It must be combined with Verifiable Credentials. Verifiable Credentials are statements about the creator of the DID. They can be shared and verified online in a BYOI manner, and the DID creator remains in complete control of the process.
+However, a DID alone tells you little about the subject. It must be combined with Verifiable Credentials. Verifiable Credentials are statements about the creator of the DID. They can be shared and verified online in a BYOI manner, and the DID creator remains in complete control of the process.
This framework can be used in processes such as:
- Address validation: Customers can prove where they live for shipping and billing addresses
diff --git a/documentation/docs/getting-started/vc/create.md b/documentation/docs/getting-started/vc/create.md
deleted file mode 100644
index e897eb3d27..0000000000
--- a/documentation/docs/getting-started/vc/create.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Create a Verifiable Credential
-sidebar_label: Create and Sign
----
-
-TODO: Explain how a VC is created and verified.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/vc/vp.md b/documentation/docs/getting-started/vc/vp.md
deleted file mode 100644
index 590b9d8e20..0000000000
--- a/documentation/docs/getting-started/vc/vp.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Verifiable Presentations
-sidebar_label: Verifiable Presentations
----
-
-TODO: Explain the need for and
\ No newline at end of file
diff --git a/documentation/docs/getting-started/verifiable_credentials/create.md b/documentation/docs/getting-started/verifiable_credentials/create.md
new file mode 100644
index 0000000000..08a9f80c4d
--- /dev/null
+++ b/documentation/docs/getting-started/verifiable_credentials/create.md
@@ -0,0 +1,13 @@
+---
+title: Create a Verifiable Credential
+sidebar_label: Create and Sign
+description: Explain how a VC is created and verified.
+image: /img/Identity_icon.png
+keywords:
+- verifiable
+- credentials
+- Create
+- sign
+---
+
+TODO: Explain how a VC is created and verified.
\ No newline at end of file
diff --git a/documentation/docs/getting-started/vc/README.md b/documentation/docs/getting-started/verifiable_credentials/overview.md
similarity index 56%
rename from documentation/docs/getting-started/vc/README.md
rename to documentation/docs/getting-started/verifiable_credentials/overview.md
index 4fc5950cd2..e33bb29521 100644
--- a/documentation/docs/getting-started/vc/README.md
+++ b/documentation/docs/getting-started/verifiable_credentials/overview.md
@@ -1,6 +1,12 @@
---
title: Verifiable Credentials Overview
sidebar_label: Overview
+description: Verifiable Credentials are statements about the holder. They can be verified online or in person, and the holder decides who to share them with.
+image: /img/Identity_icon.png
+keywords:
+- verifiable
+- credentials
+- person
---
diff --git a/documentation/docs/getting-started/vc/revoke.md b/documentation/docs/getting-started/verifiable_credentials/revoke.md
similarity index 52%
rename from documentation/docs/getting-started/vc/revoke.md
rename to documentation/docs/getting-started/verifiable_credentials/revoke.md
index d1c5e1e773..0b67d9c442 100644
--- a/documentation/docs/getting-started/vc/revoke.md
+++ b/documentation/docs/getting-started/verifiable_credentials/revoke.md
@@ -1,6 +1,13 @@
---
title: Verifiable Credential Revocation
sidebar_label: Revocation
+description: Explain how a VC is revoked.
+image: /img/Identity_icon.png
+keywords:
+- verifiable
+- credentials
+- revoke
+- Merkle Key Collections
---
diff --git a/documentation/docs/getting-started/verifiable_credentials/verifiable_presentations.md b/documentation/docs/getting-started/verifiable_credentials/verifiable_presentations.md
new file mode 100644
index 0000000000..0e7d3cd3ad
--- /dev/null
+++ b/documentation/docs/getting-started/verifiable_credentials/verifiable_presentations.md
@@ -0,0 +1,11 @@
+---
+title: Verifiable Presentations
+sidebar_label: Verifiable Presentations
+description: Explain how a VC is created and verified.
+image: /img/Identity_icon.png
+keywords:
+- verifiable
+- presentations
+---
+
+TODO: Explain the need for and
\ No newline at end of file
diff --git a/documentation/docs/glossary.md b/documentation/docs/glossary.md
index 939529a3e9..69da69bd55 100644
--- a/documentation/docs/glossary.md
+++ b/documentation/docs/glossary.md
@@ -1,3 +1,14 @@
+---
+description: Glossary for IOTA Identity, defines the terms used in this specification and throughout decentralized identifier infrastructure.
+image: /img/Identity_icon.png
+keywords:
+- W3C
+- terminology
+- IOTA
+- verification method
+- verifiable data registry
+---
+
# Glossary
The first part describes the terminology by the W3C.
diff --git a/documentation/docs/intro.md b/documentation/docs/introduction.md
similarity index 61%
rename from documentation/docs/intro.md
rename to documentation/docs/introduction.md
index 09dbc0919e..04c443e157 100644
--- a/documentation/docs/intro.md
+++ b/documentation/docs/introduction.md
@@ -1,6 +1,11 @@
---
-sidebar_position: 1
-title: Introduction
+keywords:
+- Identity
+- guide
+- TOC
+- overview
+description: The most important concepts that developers will need to know to utilize IOTA Identity to its full potential.
+image: /img/Identity_icon.png
---
# IOTA Identity Framework Guide
@@ -9,51 +14,51 @@ title: Introduction
The IOTA Identity framework implements the most common standards and patterns for Decentralized Identity in both a DLT agnostic and `iota` method specification manner. It is designed to work for Identity for People, Organizations, Things, and Objects acting as a unifying-layer of trust between everyone and everything.
-In this guide, we will go through the most important concepts that developers will need to know to utilize IOTA Identity to its full potential. The guide is programming language agnostic, with langauge specific guides located in Chapter 4.
+In this guide, we will go through the most important concepts that developers will need to know to utilize IOTA Identity to its full potential. The guide is programming language agnostic, with language specific guides located in Chapter 4.
-### Overview
+## Overview
-**Chapter 2: Decentralized Identity**
+### Chapter 2: Decentralized Identity
Describes the concept of Decentralized or Self Sovereign Identities (SSI), how it applies to People, Organizations and Things, and why IOTA is used.
-**Chapter 3.1: Decentralized Identifiers (DID)**
+### Chapter 3.1: Decentralized Identifiers (DID)
Explains the DID standard from W3C, how to manipulate DID Documents and Merkle Key Collections, the basis of our revocation mechanism.
-**Chapter 3.2: Verifiable Credentials (VC)**
+### Chapter 3.2: Verifiable Credentials (VC)
-Explains the VC standard from W3C, how to create and revoke VCs and how to use Verifiable Presentations.
+Explains the VC standard from W3C, how to create and revoke VCs, and how to use Verifiable Presentations.
-**Chapter 3.3: DID Communications (DID Comm)**
+### Chapter 3.3: DID Communications (DID Comm)
-This chapter covers the DID Comm standard, which is being developed by the Decentralized Identity Foundation (DIF). It also describes the different messages agents may sent each other and what the expected responses may look like.
+This chapter covers the DID Comm standard, which is being developed by the Decentralized Identity Foundation (DIF). It also describes the different messages agents may send each other and what the expected responses may look like.
-**Chapter 3.4: Advanced Concepts**
+### Chapter 3.4: Advanced Concepts
-This chapter is ment for those that want to push the IOTA Identity framework to its limits, utilizing the more complex, yet more flexible lower level libraries, allowing developers to optimize their implementation, take control over storage/security, and add features to the framework.
+This chapter is meant for those that want to push the IOTA Identity framework to its limits, utilizing the more complex, yet more flexible lower level libraries, allowing developers to optimize their implementation, take control over storage/security, and add features to the framework.
-**Chapter 4: Programming Languages**
+### Chapter 4: Programming Languages
-While the framework itself is developed in the Rust programming language, we also provide bindings, or "Foreign Function Interfaces" (FFI), to other languages. These will have seperate getting started sections, making the rest of the guide language agnostic, focusing on the conceptual level.
+While the framework itself is developed in the Rust programming language, we also provide bindings, or "Foreign Function Interfaces" (FFI), to other languages. These will have separate getting started sections, making the rest of the guide language agnostic, focusing on the conceptual level.
-**Chapter 5: Specification**
+### Chapter 5: Specification
While IOTA Identity implements many existing standards, it also adds some additional features we would like to standardize ourselves. This chapter covers these features and how they work in great detail. These are not light reads and can be skipped.
-**Chapter 6: Glossary**
+### Chapter 6: Glossary
A list of all terminology used in this guide, the framework and all materials surrounding it.
-**Chapter 7: Contribute**
+### Chapter 7: Contribute
A simple guide on how to contribute to the framework.
-**Chapter 8: Contact**
+### Chapter 8: Contact
How to contact the maintainers.
-**Chapter 9: FAQ**
+### Chapter 9: FAQ
Overview of the most Frequently Asked Questions, and their answers.
diff --git a/documentation/docs/libraries/README.md b/documentation/docs/libraries/README.md
index dc95cf2f37..918d852832 100644
--- a/documentation/docs/libraries/README.md
+++ b/documentation/docs/libraries/README.md
@@ -2,5 +2,5 @@
We currently support the following libraries:
-- [Rust](./rust/README)
-- [WASM](./wasm/README)
+- [Rust](rust/overview.md)
+- [WASM](wasm/overview.md)
diff --git a/documentation/docs/libraries/rust/api_reference.md b/documentation/docs/libraries/rust/api_reference.md
index 66c0bb00ee..162e480c47 100644
--- a/documentation/docs/libraries/rust/api_reference.md
+++ b/documentation/docs/libraries/rust/api_reference.md
@@ -1,6 +1,11 @@
---
title: API Reference
sidebar_label: API Reference
+description: Rust API reference. Learn how generate docs for the whole crate.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- API Reference
---
Link to hosted api documentation:
diff --git a/documentation/docs/libraries/rust/examples.md b/documentation/docs/libraries/rust/examples.md
index b6704b6f91..84c2f6d5a1 100644
--- a/documentation/docs/libraries/rust/examples.md
+++ b/documentation/docs/libraries/rust/examples.md
@@ -1,4 +1,9 @@
---
title: Examples
sidebar_label: Rust Examples
+description: Rust Examples.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- Examples
---
diff --git a/documentation/docs/libraries/rust/getting_started.md b/documentation/docs/libraries/rust/getting_started.md
index 0a8ec6eacc..23dc789aea 100644
--- a/documentation/docs/libraries/rust/getting_started.md
+++ b/documentation/docs/libraries/rust/getting_started.md
@@ -1,4 +1,9 @@
---
title: Getting Started with Rust
sidebar_label: Getting Started
+description: Getting started with the IOTA Identity Rust Library.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- Identity
---
diff --git a/documentation/docs/libraries/rust/README.md b/documentation/docs/libraries/rust/overview.md
similarity index 65%
rename from documentation/docs/libraries/rust/README.md
rename to documentation/docs/libraries/rust/overview.md
index df6d200710..b0d8d74c03 100644
--- a/documentation/docs/libraries/rust/README.md
+++ b/documentation/docs/libraries/rust/overview.md
@@ -1,6 +1,13 @@
---
title: IOTA Identity Rust Library
sidebar_label: Overview
+description: Overview of the IOTA Identity Rust Library.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- API Reference
+- Examples
+- Troubleshooting
---
# IOTA Identity Rust Library
diff --git a/documentation/docs/libraries/rust/troubleshooting.md b/documentation/docs/libraries/rust/troubleshooting.md
index 6086ebc483..fdea8c0650 100644
--- a/documentation/docs/libraries/rust/troubleshooting.md
+++ b/documentation/docs/libraries/rust/troubleshooting.md
@@ -1,4 +1,9 @@
---
title: Rust Troubleshooting
sidebar_label: Troubleshooting
+description: Troubleshooting the IOTA Identity Rust Library.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- Identity
---
diff --git a/documentation/docs/libraries/wasm/api_reference.md b/documentation/docs/libraries/wasm/api_reference.md
index d872729836..9f5ade7c83 100644
--- a/documentation/docs/libraries/wasm/api_reference.md
+++ b/documentation/docs/libraries/wasm/api_reference.md
@@ -1,6 +1,11 @@
---
title: WASM API Reference
sidebar_label: API Reference
+description: WASM API reference.
+image: /img/Identity_icon.png
+keywords:
+- WASM
+- API Reference
---
{@import ../../../../bindings/wasm/docs/api-reference.md}
\ No newline at end of file
diff --git a/documentation/docs/libraries/wasm/examples.md b/documentation/docs/libraries/wasm/examples.md
index 92c3de106d..69971f6793 100644
--- a/documentation/docs/libraries/wasm/examples.md
+++ b/documentation/docs/libraries/wasm/examples.md
@@ -1,4 +1,9 @@
---
title: WASM Examples
sidebar_label: Examples
+description: WASM Examples.
+image: /img/Identity_icon.png
+keywords:
+- WASM
+- Examples
---
diff --git a/documentation/docs/libraries/wasm/getting_started.md b/documentation/docs/libraries/wasm/getting_started.md
index 6950530801..94af633e4c 100644
--- a/documentation/docs/libraries/wasm/getting_started.md
+++ b/documentation/docs/libraries/wasm/getting_started.md
@@ -1,6 +1,16 @@
---
title: Getting Started with WASM
sidebar_label: Getting Started
+description: Getting started with the IOTA Identity WASM Library.
+image: /img/Identity_icon.png
+keywords:
+- WASM
+- install
+- npm
+- yarn
+- build
+- nodejs
+- webpack
---
{@import ../../../../bindings/wasm/README.md}
\ No newline at end of file
diff --git a/documentation/docs/libraries/wasm/README.md b/documentation/docs/libraries/wasm/overview.md
similarity index 64%
rename from documentation/docs/libraries/wasm/README.md
rename to documentation/docs/libraries/wasm/overview.md
index f78b3ed6c6..3fa09f1b4a 100644
--- a/documentation/docs/libraries/wasm/README.md
+++ b/documentation/docs/libraries/wasm/overview.md
@@ -1,6 +1,13 @@
---
title: IOTA Identity WASM Library
sidebar_label: Overview
+description: Overview of the IOTA Identity WASM Library.
+image: /img/Identity_icon.png
+keywords:
+- WASM
+- API Reference
+- Examples
+- Troubleshooting
---
diff --git a/documentation/docs/libraries/wasm/troubleshooting.md b/documentation/docs/libraries/wasm/troubleshooting.md
index 398b66435c..dc9ef61650 100644
--- a/documentation/docs/libraries/wasm/troubleshooting.md
+++ b/documentation/docs/libraries/wasm/troubleshooting.md
@@ -1,4 +1,11 @@
---
title: WASM Troubleshooting
sidebar_label: Troubleshooting
+description: Troubleshooting of the IOTA Identity Rust Library.
+image: /img/Identity_icon.png
+keywords:
+- Rust
+- API Reference
+- Examples
+- Troubleshooting
---
\ No newline at end of file
diff --git a/documentation/docs/specs/README.md b/documentation/docs/specs/README.md
deleted file mode 100644
index 7073b739e0..0000000000
--- a/documentation/docs/specs/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: Overview
-sidebar_label: Overview
----
-
-TODO
\ No newline at end of file
diff --git a/documentation/docs/specs/iota_did_method_spec.md b/documentation/docs/specs/iota_did_method_spec.md
index 60beefe715..adc9039cc7 100644
--- a/documentation/docs/specs/iota_did_method_spec.md
+++ b/documentation/docs/specs/iota_did_method_spec.md
@@ -1,6 +1,15 @@
---
title: IOTA DID Method Specification
sidebar_label: DID Method
+description: How IOTA Identity implements the Decentralized Identifiers Standard on the IOTA Tangle.
+image: /img/Identity_icon.png
+keywords:
+- DID
+- specs
+- specifications
+- Decentralized Identifiers
+- Tangle
+- format
---
# IOTA DID Method Specification
@@ -19,7 +28,8 @@ This specification defines a method of implementing DID on top of the [IOTA Tang
Blockchain | Tangle
:---------:|:---------:
- | 
+
+ | 
For this method, the most important features of IOTA are:
diff --git a/documentation/docs/specs/merkle_key_collection.md b/documentation/docs/specs/merkle_key_collection.md
index 4dbafb2e45..4e1997d6c5 100644
--- a/documentation/docs/specs/merkle_key_collection.md
+++ b/documentation/docs/specs/merkle_key_collection.md
@@ -1,6 +1,15 @@
---
title: Merkle Key Collection Specification
sidebar_label: Merkle Key Collection
+description: The Merkle Key Collection Specification provides authentication and integrity protection to DID Documents without a dependency on any particular Distributed Ledger Technology (DLT).
+image: /img/Identity_icon.png
+keywords:
+- Merkle Key Collection
+- Documents
+- DID
+- DLT
+- Specifications
+- Specs
---
Version 0.1-draft by Devin Turner, IOTA Foundation
diff --git a/documentation/docs/specs/overview.md b/documentation/docs/specs/overview.md
new file mode 100644
index 0000000000..a38034631b
--- /dev/null
+++ b/documentation/docs/specs/overview.md
@@ -0,0 +1,11 @@
+---
+title: Overview
+sidebar_label: Overview
+description: IOTA Identity specifications overview.
+image: /img/Identity_icon.png
+keywords:
+- specs
+- specifications
+---
+
+TODO
\ No newline at end of file
diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js
index 5889304212..33ba1a6078 100644
--- a/documentation/docusaurus.config.js
+++ b/documentation/docusaurus.config.js
@@ -7,12 +7,11 @@ module.exports = {
tagline: 'Providing Trust between Individuals, Organizations and Things.',
url: 'https://identity.docs.iota.org',
baseUrl: '/',
- onBrokenLinks: 'throw',
+ onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'iotaledger', // Usually your GitHub org/user name.
projectName: 'identity.rs', // Usually your repo name.
- onBrokenLinks: 'warn',
stylesheets: [
'https://fonts.googleapis.com/css?family=Material+Icons',
],
@@ -26,7 +25,7 @@ module.exports = {
items: [
{
type: 'doc',
- docId: 'intro',
+ docId: 'introduction',
position: 'left',
label: 'Documentation',
},
@@ -51,15 +50,15 @@ module.exports = {
},
{
label: 'Rust',
- to: '/docs/libraries/rust/README',
+ to: '/docs/libraries/rust/overview',
},
{
label: 'WASM',
- to: '/docs/libraries/wasm/README',
+ to: '/docs/libraries/wasm/overview',
},
{
label: 'Specification',
- to: '/docs/specs/README',
+ to: '/docs/specs/overview',
},
],
},
diff --git a/documentation/package.json b/documentation/package.json
index abae28fec2..621e912a3a 100644
--- a/documentation/package.json
+++ b/documentation/package.json
@@ -14,8 +14,8 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
- "@docusaurus/core": "^2.0.0-beta.6f366f4b4",
- "@docusaurus/preset-classic": "^2.0.0-beta.6f366f4b4",
+ "@docusaurus/core": "^2.0.0-beta.4",
+ "@docusaurus/preset-classic": "^2.0.0-beta.4",
"@mdx-js/react": "^1.6.21",
"@svgr/webpack": "^5.5.0",
"clsx": "^1.1.1",
diff --git a/documentation/sidebars.js b/documentation/sidebars.js
index 4f97b1c3c4..d197f03039 100644
--- a/documentation/sidebars.js
+++ b/documentation/sidebars.js
@@ -10,99 +10,107 @@
*/
module.exports = {
- // By default, Docusaurus generates a sidebar from the docs folder structure
- // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+ // By default, Docusaurus generates a sidebar from the docs folder structure
+ // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
- // But you can create a sidebar manually
+ // But you can create a sidebar manually
- docs: [
- 'intro',
- 'intro_ssi',
- {
- type: 'category',
- label: 'Getting Started',
- collapsed: false,
- items: [
- 'getting-started/overview',
+ docs: [
{
- 'Decentralized Identifiers (DID)': [
- 'getting-started/did/README',
- 'getting-started/did/create',
- 'getting-started/did/resolve',
- 'getting-started/did/update',
- 'getting-started/did/merkle_key_collection',
- ],
+ type: 'doc',
+ id: 'introduction',
+ label: 'Introduction'
},
{
- 'Verifiable Credentials': [
- 'getting-started/vc/README',
- 'getting-started/vc/create',
- 'getting-started/vc/revoke',
- 'getting-started/vc/vp',
- ]
+ type:'doc',
+ id:'decentralized_identity',
+ label:'Decentralized Identity'
},
{
- 'DID Communication': [
- 'getting-started/didcomm/README',
- 'getting-started/didcomm/did_comm_messages',
- 'getting-started/didcomm/protocols',
- ],
- 'Advanced Concepts':[
- 'getting-started/advanced/README',
- 'getting-started/advanced/client',
- 'getting-started/advanced/did_messages',
- 'getting-started/advanced/storage_adapter',
- 'getting-started/advanced/signature_schemes',
+ type: 'category',
+ label: 'Getting Started',
+ collapsed: false,
+ items: [
+ 'getting-started/overview',
+ {
+ 'Decentralized Identifiers (DID)': [
+ 'getting-started/decentralized_identifiers/overview',
+ 'getting-started/decentralized_identifiers/create',
+ 'getting-started/decentralized_identifiers/resolve',
+ 'getting-started/decentralized_identifiers/update',
+ 'getting-started/decentralized_identifiers/merkle_key_collection',
+ ],
+ },
+ {
+ 'Verifiable Credentials': [
+ 'getting-started/verifiable_credentials/overview',
+ 'getting-started/verifiable_credentials/create',
+ 'getting-started/verifiable_credentials/revoke',
+ 'getting-started/verifiable_credentials/verifiable_presentations',
+ ]
+ },
+ {
+ 'DID Communication': [
+ 'getting-started/did_communications/overview',
+ 'getting-started/did_communications/did_comm_messages',
+ 'getting-started/did_communications/protocols',
+ ],
+ 'Advanced Concepts': [
+ 'getting-started/advanced/overview',
+ 'getting-started/advanced/client',
+ 'getting-started/advanced/did_messages',
+ 'getting-started/advanced/storage_adapter',
+ 'getting-started/advanced/signature_schemes',
- ]
+ ]
+ },
+ ],
},
- ],
- },
- {
- type: 'category',
- label: 'Programming Languages',
- collapsed: true,
- items: [
{
- type: 'category',
- label: 'Rust',
- collapsed: true,
- items: [
- 'libraries/rust/README',
- 'libraries/rust/getting_started',
- 'libraries/rust/examples',
- 'libraries/rust/api_reference',
- 'libraries/rust/troubleshooting',
- ],
-
+ type: 'category',
+ label: 'Programming Languages',
+ collapsed: true,
+ items: [
+ {
+ type: 'category',
+ label: 'Rust',
+ collapsed: true,
+ items: [
+ 'libraries/rust/overview',
+ 'libraries/rust/getting_started',
+ 'libraries/rust/examples',
+ 'libraries/rust/api_reference',
+ 'libraries/rust/troubleshooting',
+ ],
+
+ },
+ {
+ type: 'category',
+ label: 'WASM',
+ collapsed: true,
+ items: [
+ 'libraries/wasm/overview',
+ 'libraries/wasm/getting_started',
+ 'libraries/wasm/examples',
+ 'libraries/wasm/api_reference',
+ 'libraries/wasm/troubleshooting',
+ ],
+ },
+ ],
},
{
- type: 'category',
- label: 'WASM',
- collapsed: true,
- items: [
- 'libraries/wasm/README',
- 'libraries/wasm/getting_started',
- 'libraries/wasm/examples',
- 'libraries/wasm/api_reference',
- 'libraries/wasm/troubleshooting',
- ],
+ type: 'category',
+ label: 'Specificatons',
+ collapsed: true,
+ items: [
+ 'specs/overview',
+ 'specs/iota_did_method_spec',
+ 'specs/merkle_key_collection',
+ ],
},
- ],
- },
- {
- type: 'category',
- label: 'Specificatons',
- collapsed: true,
- items: [
- 'specs/README',
- 'specs/iota_did_method_spec',
- 'specs/merkle_key_collection',
- ],
- },
- 'glossary',
- 'contribute',
- 'contact',
- 'faq'
- ],
+ 'glossary',
+ 'contribute',
+ 'contact',
+ 'faq'
+ ],
};
diff --git a/documentation/src/components/HomepageFeatures.js b/documentation/src/components/HomepageFeatures.js
deleted file mode 100644
index 931c445e56..0000000000
--- a/documentation/src/components/HomepageFeatures.js
+++ /dev/null
@@ -1,62 +0,0 @@
-import React from 'react';
-import clsx from 'clsx';
-import styles from './HomepageFeatures.module.css';
-import LandingpageHeader from './LandingpageHeader';
-
-const FeatureList = [
- {
- title: 'Identity Of Things',
- Svg: require('../../static/img/undraw_docusaurus_mountain.svg').default,
- description: (
- <>
- Devices have an identity that proves their capabilities, specifications, and authenticity to allow others to feel confident in transacting with them.
-
- ),
- },
- {
- title: 'Self Sovereign Identity',
- Svg: require('../../static/img/undraw_docusaurus_tree.svg').default,
- description: (
- <>
- Individuals have a borderless digital identity that can be verified by anyone or anything in the world.
-
- ),
- },
- {
- title: 'Regulatory Compliance',
- Svg: require('../../static/img/undraw_docusaurus_react.svg').default,
- description: (
- <>
- Organizations can use digital identities to follow regulations such as GDPR in a more cost-efficient way.
-
- ),
- },
-];
-
-function Feature({Svg, title, description}) {
- return (
-