Skip to content

Commit

Permalink
Updated Mdbook structure
Browse files Browse the repository at this point in the history
  • Loading branch information
JelleMillenaar authored and JelleMillenaar committed Mar 16, 2021
1 parent 5910fa6 commit 972d5d0
Show file tree
Hide file tree
Showing 25 changed files with 80 additions and 7 deletions.
32 changes: 26 additions & 6 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
- [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)
3 changes: 3 additions & 0 deletions docs/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Contact

TODO: Add ways to contact the maintainers
3 changes: 3 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Frequently Asked Questions

TODO: Add list of frequently asked questions and there answers
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/overview/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/overview/advanced/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Advanced Concepts

TODO: Provide overview of the advanced concepts
3 changes: 3 additions & 0 deletions docs/overview/advanced/client.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/overview/advanced/did_messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## DID Messages

TODO: Explain the concept of DID Messages and how they can be used to optimize DID updates.
3 changes: 3 additions & 0 deletions docs/overview/advanced/signature_schemes.md
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 3 additions & 0 deletions docs/overview/advanced/storage_adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Storage Adapter

TODO: Explain the need for the storage adapter and how it can used to store account data differently
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/overview/did/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Creating a Decentralized Identity

TODO: Explain DID, DID Documents and publishing them to the Tangle.
3 changes: 3 additions & 0 deletions docs/overview/did/merkle_key_collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Merkle Key Collection

TODO: Explain why, how to use and how merkle key collections work.
3 changes: 3 additions & 0 deletions docs/overview/did/resolve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Resolve an IOTA Identity

TODO: Explain how resolving works including arguments.
3 changes: 3 additions & 0 deletions docs/overview/did/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Update DID Documents

TODO: Explain how DID Documents can be manipulated and how updates should be published.
3 changes: 3 additions & 0 deletions docs/overview/didcomm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## DID Communications

TODO: Explain the DID Communications standard and what it is useful for
3 changes: 3 additions & 0 deletions docs/overview/didcomm/did_comm_messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## DID Communcation Messages

TODO: Explain how to create and verify DID Comm messages
3 changes: 3 additions & 0 deletions docs/overview/didcomm/protocols.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## DID Comm Protocols

TODO: Provide an overview of the DID Comm protocols
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/overview/vc/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Create a Verifiable Credential

TODO: Explain how a VC is created and verified.
3 changes: 3 additions & 0 deletions docs/overview/vc/revoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Verifiable Credential Revocation

TODO: Explain how Verifiable Credentials are revoked using Merkle Key Collections
3 changes: 3 additions & 0 deletions docs/overview/vc/vp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Verifiable Presentations

TODO: Explain the need for and
1 change: 1 addition & 0 deletions docs/specs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO
File renamed without changes.
1 change: 1 addition & 0 deletions docs/specs/method_spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO

0 comments on commit 972d5d0

Please sign in to comment.