chore: update docs (#134)

*chore: update docs Co-authored-by: Martin Domajnko <35891136+martines3000@users.noreply.github.com>
blockchain-lab-um · Mar 20, 2023 · 8f4dab8 · 8f4dab8
1 parent 48b8a44
commit 8f4dab8
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -12,8 +12,8 @@ The SSI Snap enables everyone to build their **decentralized and self-sovereign
 The SSI Snap is built agnostic, leaving the user to choose his preferred **blockchain, DID method, and data storage provider.** Everything is configurable, just like selecting the network in MetaMask. Currently supported technologies:
 
 - **Blockchains:** Any EVM-based blockchain that is supported by DID methods
-- **DID methods:** `did:ethr`, `did:key`
-- **Data storage providers:** Local (MetaMask Snap state), Ceramic
+- **DID methods:** `did:ethr`, `did:key`, `did:pkh`
+- **Data storage providers:** Local MetaMask Snap state, Ceramic Network
 
 Many new features are already in the works. For more information, please check the [roadmap](https://blockchain-lab-um.github.io/ssi-snap-docs/docs/roadmap) on the documentation.
 

diff --git a/packages/docs/docs/apps/app.md b/packages/docs/docs/apps/app.md
diff --git a/packages/docs/docs/apps/dapp.md b/packages/docs/docs/apps/dapp.md
@@ -0,0 +1,20 @@
+---
+sidebar_position: 1
+---
+
+# SSI Snap dApp
+
+**[SSI Snap dApp](https://blockchain-lab-um.github.io/ssi-snap)** is the official app for interacting with SSI Snap and configuring it.
+
+Users can use the official app to:
+
+- view all of their VCs,
+- create a custom VP using one or more credentials,
+- import a credential,
+- change DID method,
+- configure SSI Snap,
+- and many other things that will come...
+
+![SSI Snap dApp](https://i.imgur.com/Hko00tM.png)
+
+SSI Snap dApp is certainly not the only way of interacting with SSI Snap. Any dApp can connect to SSI Snap similarly to the MetaMask!
diff --git a/packages/docs/docs/getting-started.md b/packages/docs/docs/getting-started.md
@@ -12,7 +12,7 @@ The SSI Snap is a **MetaMask Snap** (extension) that adds support for **SSI**: i
 
 ### How to start using the SSI Snap?
 
-SSI Snap currently works only on **MetaMask Flask**. You can find it [here](https://metamask.io/flask/). Snaps are expected to come to the main MetaMask in 2023.
+SSI Snap currently works only on **MetaMask Flask**. You can find it [here](https://metamask.io/flask/). Snaps are expected to come to the main MetaMask sometime in the second half of 2023.
 
 After that, connect to any dApp that uses SSI Snap, and you are good to go!
 

diff --git a/packages/docs/docs/libraries/data-manager.md b/packages/docs/docs/libraries/data-manager.md
@@ -165,5 +165,5 @@ export interface IDataManagerSaveResult {
 }
 ```
 
-**[GitHub](https://github.com/blockchain-lab-um/veramo-vc-manager) |
+**[GitHub](https://github.com/blockchain-lab-um/ssi-snap/tree/master/packages/vcmanager) |
 [npm](https://www.npmjs.com/package/@blockchain-lab-um/veramo-vc-manager)**
diff --git a/packages/docs/docs/libraries/ssi-snap-connector.md b/packages/docs/docs/libraries/ssi-snap-connector.md
@@ -6,7 +6,7 @@ sidebar_position: 1
 
 SSI Snap connector is used to install SSI snap and expose API toward snap on dApps and other applications.
 
-For more details on SSI Snap Connector, check [ssi-snap-connector repo](https://github.com/blockchain-lab-um/ssi-snap-connector).
+For more details on SSI Snap Connector, check [GitHub repo](https://github.com/blockchain-lab-um/ssi-snap/tree/master/packages/connector).
 
 ## Usage
 

diff --git a/packages/docs/docs/roadmap.md b/packages/docs/docs/roadmap.md
@@ -10,11 +10,12 @@ DID methods:
 
 - [x] `did:ethr`
 - [x] `did:key`
-- [ ] `did:pkh`
-- [ ] `did:cheqd`
+- [x] `did:pkh`
 - [ ] `did:jwk`
-- [ ] `did:ens`
+- [ ] `did:cheqd`
 - [ ] `did:ebsi`
+- [ ] `did:ens`
+- [ ] `did:polygon`
 - [ ] ...
 
 Verifiable Credentials (VCs):
@@ -33,10 +34,19 @@ Verifiable Presentations (VPs):
 - [x] Create with multiple VCs
 - [ ] ...
 
+Storage options:
+
+- [x] MetaMask Snap State (local, off-chain)
+- [x] Ceramic Network
+- [ ] Google Drive
+- [ ] Kepler (SpruceID)
+- [ ] ...
+
 Cryptography:
 
 - [x] Signing with MetaMask keys
-- [ ] Selective Disclosure
+- [ ] Selective Disclosure - SD-JWT
+- [ ] Selective Disclosure - BBS+
 - [ ] Zero-Knowledge Proofs (ZKPs)
 - [ ] ...
 
@@ -48,14 +58,7 @@ Proof formats:
 - [ ] JSON Web Proofs
 - [ ] ...
 
-Storage options:
-
-- [x] MetaMask Snap State (local, off-chain)
-- [x] Ceramic Network
-- [ ] Google Drive
-- [ ] ...
-
-Identity standards:
+Digital identity standards:
 
 - [ ] PEX (Presentation Exchange)
 - [ ] OpenID Connect (SIOP, OIDC4VC, and OIDC4VP)
@@ -64,23 +67,22 @@ Identity standards:
 - [ ] DIDComm
 - [ ] ...
 
-SSI Snap functionality:
-
-- [ ] Manage Profile (did:ethr, ...)
-- [ ] Snap UI Elements
-- [ ] Sync using Ceramic/Google Drive
-- [ ] ...
-
 SSI Snap dApp:
 
 - [x] DID method selection
 - [x] Import, list, and delete VCs
-- [x] Changing JSON API tokens (Infura)
-- [x] Manage Settings
-- [ ] Create JWTs
-- [ ] Import/Export (backup VCs)
-- [ ] Manage Profiles (did:ethr, ...)
-- [ ] Public Profiles (did:ethr, ...)
+- [x] Manage settings
+- [ ] Create VPs
+- [ ] Move VC to another storage
+- [ ] Import/export (backup VCs)
+- [ ] Public profiles
+- [ ] ...
+
+Snaps-related functionality:
+
+- [ ] Snap UI Elements
+- [ ] Settings and storage synchronization across multiple devices
+- [ ] Featured on Snaps registry
 - [ ] ...
 
 dApp integrations:

diff --git a/packages/docs/docs/ssi-snap/architecture.md b/packages/docs/docs/ssi-snap/architecture.md
@@ -15,7 +15,7 @@ As already mentioned, SSI Snap is a MetaMask Snap extension. MetaMask Snaps is a
 
 Veramo client powers the SSI Snap. Inside SSI Snap, Veramo Client is used to manage DIDs and VCs, using Veramos **DIDManager**, **KeyManager** and **PrivateKeyManager** plugins and our custom **[DataManager plugin](../libraries/data-manager)**.
 
-**DIDManager**, **KeyManager**, **PrivateKeyManager** and **[DataManager](../libraries/data-manager)** plugins take care of managing and storing data. They all come with an abstract data-store class, e.g. [AbstractVCStore](https://github.com/blockchain-lab-um/veramo-vc-manager/blob/main/src/vc-store/abstract-vc-store.ts). Using said class, we implemented custom data-store plugins, that save data inside the MetaMask state or on the Ceramic Network.
+**DIDManager**, **KeyManager**, **PrivateKeyManager** and **[DataManager](../libraries/data-manager)** plugins take care of managing and storing data. They all come with an abstract data-store class, e.g. [AbstractDataStore](https://github.com/blockchain-lab-um/ssi-snap/blob/master/packages/vcmanager/src/data-store/abstractDataStore.ts). Using said class, we implemented custom data-store plugins, that save data inside the MetaMask state or on the Ceramic Network.
 
 These abstract classes make implementing different ways of storing data easy.
 

diff --git a/packages/docs/docs/ssi-snap/storage.md b/packages/docs/docs/ssi-snap/storage.md
@@ -17,7 +17,7 @@ Data-store plugins, used by Veramo Client and Manager plugins, modify the state.
 
 :::info Private Keys
 
-It is important to note that MetaMask Account private keys are **NEVER** exported from MetaMask! They are only used during RPC calls and are deleted from memory after the RPC method is done!
+It is important to note that MetaMask Account private keys are **NEVER** exported from MetaMask! They are only used during RPC calls and are deleted from memory after the RPC method finishes with the execution!
 
 :::
 

diff --git a/packages/docs/docs/ssi-snap/supported.md b/packages/docs/docs/ssi-snap/supported.md
@@ -8,10 +8,11 @@ DID methods:
 
 - [`did:ethr`](https://github.com/decentralized-identity/ethr-did-resolver/blob/master/doc/did-method-spec.md)
 - [`did:key`](https://w3c-ccg.github.io/did-method-key/)
+- [`did:pkh`](https://github.com/w3c-ccg/did-pkh/blob/main/did-pkh-method-draft.md)
 
 Data Storage:
 
-- [MetaMask Snap](https://docs.metamask.io/guide/snaps.html) State (local, off-chain)
+- Local [MetaMask Snap](https://docs.metamask.io/guide/snaps.html) state (fully off-chain)
 - [Ceramic Network](https://ceramic.network/)
 
 :::danger

diff --git a/packages/docs/docs/tutorial/implementation.md b/packages/docs/docs/tutorial/implementation.md
@@ -8,7 +8,7 @@ The **SSI Snap** is a MetaMask Snap, that can handle **DIDs**, securely store **
 
 :::danger
 
-Ceramic network and DID:KEY support are experimental and still under development!
+Ceramic Network support is experimental and still under development!
 
 :::
 

diff --git a/packages/docs/docs/tutorial/rpc-methods.md b/packages/docs/docs/tutorial/rpc-methods.md
@@ -226,13 +226,7 @@ Switch the DID method
 
 #### Parameters
 
-1. didMethod - name of did method ("did:ethr" or "did:key"). Must be one of methods returned by `getAvailableMethods`.
-
-:::danger
-
-DID:KEY support is experimental and still under development!
-
-:::
+1. didMethod - name of did method (`did:ethr`, `did:key`, or `did:pkh`). Must be one of methods returned by `getAvailableMethods`.
 
 ```typescript
 const response = await ethereum.request({
@@ -295,7 +289,7 @@ Change the selected VC Store plugin
 
 :::danger
 
-Ceramic network support is experimental and still under development!
+Ceramic Network support is experimental and still under active development!
 
 :::