diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 0246f23743..bf7c4cfa6e 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,10 +1,25 @@ # Summary -- [Welcome](./welcome.md) +- [Introduction](./introduction.md) - [Overview](./overview/README.md) - - [Decentralized Identifiers](./overview/did.md) - - [Verifiable Credentials](./overview/vc.md) -- [Libraries](./libraries/README.md) + - [Decentralized Identifiers(DID)](./overview/did/README.md) + - [Create and Publish](./overview/did/create.md) + - [Resolve](./overview/did/resolve.md) + - [Update](./overview/did/update.md) + - [Merkle Key Collection](./overview/did/merkle_key_collection.md) + - [Verifiable Credentials](./overview/vc/README.md) + - [Create and Sign](./overview/vc/create.md) + - [Revocation](./overview/vc/revoke.md) + - [Verifiable Presentations](./overview/vc/vp.md) + - [DID Communication](./overview/didcomm/README.md) + - [DID Comm messages](./overview/didcomm/did_comm_messages.md) + - [Protocols](./overview/didcomm/protocols.md) + - [Advanced Concepts](./overview/advanced/README.md) + - [IOTA Client](./overview/advanced/client.md) + - [DID Messages](./overview/advanced/did_messages.md) + - [Storage Adapter](./overview/advanced/storage_adapter.md) + - [Signature Schemes](./overview/advanced/signature_schemes.md) +- [Programming Languages](./libraries/README.md) - [Rust](./libraries/rust/README.md) - [Getting Started](./libraries/rust/getting_started.md) - [Examples](./libraries/rust/soon.md) @@ -15,5 +30,10 @@ - [Examples](./libraries/wasm/soon.md) - [API Reference](./libraries/wasm/api-reference.md) - [Troubleshooting](./libraries/wasm/soon.md) -- [Glossary](./Glossary.md) -- [Contribute](./contribute.md) \ No newline at end of file +- [Specifications](./specs/README.md) + - [DID Method Specification](./specs/method_spec.md) + - [Merkle Key Collection](./specs/merkle_key_collection.md) +- [Glossary](./glossary.md) +- [Contribute](./contribute.md) +- [Contact](./contact.md) +- [FAQ](./faq.md) \ No newline at end of file diff --git a/docs/contact.md b/docs/contact.md new file mode 100644 index 0000000000..449f166d1c --- /dev/null +++ b/docs/contact.md @@ -0,0 +1,3 @@ +## Contact + +TODO: Add ways to contact the maintainers \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000000..040579bdc7 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,3 @@ +## Frequently Asked Questions + +TODO: Add list of frequently asked questions and there answers \ No newline at end of file diff --git a/docs/welcome.md b/docs/introduction.md similarity index 100% rename from docs/welcome.md rename to docs/introduction.md diff --git a/docs/overview/README.md b/docs/overview/README.md index 1531350122..5e25d22ae6 100644 --- a/docs/overview/README.md +++ b/docs/overview/README.md @@ -1,4 +1,4 @@ -# Overwiev +# 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. diff --git a/docs/overview/advanced/README.md b/docs/overview/advanced/README.md new file mode 100644 index 0000000000..90bd9f98c4 --- /dev/null +++ b/docs/overview/advanced/README.md @@ -0,0 +1,3 @@ +## Advanced Concepts + +TODO: Provide overview of the advanced concepts \ No newline at end of file diff --git a/docs/overview/advanced/client.md b/docs/overview/advanced/client.md new file mode 100644 index 0000000000..8e6473c9fc --- /dev/null +++ b/docs/overview/advanced/client.md @@ -0,0 +1,3 @@ +## IOTA Client + +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/docs/overview/advanced/did_messages.md b/docs/overview/advanced/did_messages.md new file mode 100644 index 0000000000..19b9656b07 --- /dev/null +++ b/docs/overview/advanced/did_messages.md @@ -0,0 +1,3 @@ +## DID Messages + +TODO: Explain the concept of DID Messages and how they can be used to optimize DID updates. \ No newline at end of file diff --git a/docs/overview/advanced/signature_schemes.md b/docs/overview/advanced/signature_schemes.md new file mode 100644 index 0000000000..3b34b9176d --- /dev/null +++ b/docs/overview/advanced/signature_schemes.md @@ -0,0 +1,3 @@ +## Signature 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 diff --git a/docs/overview/advanced/storage_adapter.md b/docs/overview/advanced/storage_adapter.md new file mode 100644 index 0000000000..4a0ba4d9ab --- /dev/null +++ b/docs/overview/advanced/storage_adapter.md @@ -0,0 +1,3 @@ +## Storage Adapter + +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/docs/overview/did.md b/docs/overview/did/README.md similarity index 100% rename from docs/overview/did.md rename to docs/overview/did/README.md diff --git a/docs/overview/did/create.md b/docs/overview/did/create.md new file mode 100644 index 0000000000..229bee5fe2 --- /dev/null +++ b/docs/overview/did/create.md @@ -0,0 +1,3 @@ +## Creating a Decentralized Identity + +TODO: Explain DID, DID Documents and publishing them to the Tangle. \ No newline at end of file diff --git a/docs/overview/did/merkle_key_collection.md b/docs/overview/did/merkle_key_collection.md new file mode 100644 index 0000000000..eaa4256396 --- /dev/null +++ b/docs/overview/did/merkle_key_collection.md @@ -0,0 +1,3 @@ +## Merkle Key Collection + +TODO: Explain why, how to use and how merkle key collections work. \ No newline at end of file diff --git a/docs/overview/did/resolve.md b/docs/overview/did/resolve.md new file mode 100644 index 0000000000..b066a3b864 --- /dev/null +++ b/docs/overview/did/resolve.md @@ -0,0 +1,3 @@ +## Resolve an IOTA Identity + +TODO: Explain how resolving works including arguments. \ No newline at end of file diff --git a/docs/overview/did/update.md b/docs/overview/did/update.md new file mode 100644 index 0000000000..0ba7b5f1f4 --- /dev/null +++ b/docs/overview/did/update.md @@ -0,0 +1,3 @@ +## Update DID Documents + +TODO: Explain how DID Documents can be manipulated and how updates should be published. \ No newline at end of file diff --git a/docs/overview/didcomm/README.md b/docs/overview/didcomm/README.md new file mode 100644 index 0000000000..3737475cb0 --- /dev/null +++ b/docs/overview/didcomm/README.md @@ -0,0 +1,3 @@ +## DID Communications + +TODO: Explain the DID Communications standard and what it is useful for \ No newline at end of file diff --git a/docs/overview/didcomm/did_comm_messages.md b/docs/overview/didcomm/did_comm_messages.md new file mode 100644 index 0000000000..98a21c053d --- /dev/null +++ b/docs/overview/didcomm/did_comm_messages.md @@ -0,0 +1,3 @@ +## DID Communcation Messages + +TODO: Explain how to create and verify DID Comm messages \ No newline at end of file diff --git a/docs/overview/didcomm/protocols.md b/docs/overview/didcomm/protocols.md new file mode 100644 index 0000000000..cfdf530beb --- /dev/null +++ b/docs/overview/didcomm/protocols.md @@ -0,0 +1,3 @@ +## DID Comm Protocols + +TODO: Provide an overview of the DID Comm protocols \ No newline at end of file diff --git a/docs/overview/vc.md b/docs/overview/vc/README.md similarity index 100% rename from docs/overview/vc.md rename to docs/overview/vc/README.md diff --git a/docs/overview/vc/create.md b/docs/overview/vc/create.md new file mode 100644 index 0000000000..b93ab0a970 --- /dev/null +++ b/docs/overview/vc/create.md @@ -0,0 +1,3 @@ +## Create a Verifiable Credential + +TODO: Explain how a VC is created and verified. \ No newline at end of file diff --git a/docs/overview/vc/revoke.md b/docs/overview/vc/revoke.md new file mode 100644 index 0000000000..16f9a4e252 --- /dev/null +++ b/docs/overview/vc/revoke.md @@ -0,0 +1,3 @@ +## Verifiable Credential Revocation + +TODO: Explain how Verifiable Credentials are revoked using Merkle Key Collections \ No newline at end of file diff --git a/docs/overview/vc/vp.md b/docs/overview/vc/vp.md new file mode 100644 index 0000000000..db862b143b --- /dev/null +++ b/docs/overview/vc/vp.md @@ -0,0 +1,3 @@ +## Verifiable Presentations + +TODO: Explain the need for and \ No newline at end of file diff --git a/docs/specs/README.md b/docs/specs/README.md new file mode 100644 index 0000000000..30404ce4c5 --- /dev/null +++ b/docs/specs/README.md @@ -0,0 +1 @@ +TODO \ No newline at end of file diff --git a/docs/specs/merkle-key-collection.md b/docs/specs/merkle_key_collection.md similarity index 100% rename from docs/specs/merkle-key-collection.md rename to docs/specs/merkle_key_collection.md diff --git a/docs/specs/method_spec.md b/docs/specs/method_spec.md new file mode 100644 index 0000000000..30404ce4c5 --- /dev/null +++ b/docs/specs/method_spec.md @@ -0,0 +1 @@ +TODO \ No newline at end of file