Split Key Concepts into Key Concepts and Trinsic Platform (#788)

trinsic-id · Jun 23, 2022 · 4f61c97 · 4f61c97
1 parent ccf8a8e
commit 4f61c97
Show file tree

Hide file tree

Showing 17 changed files with 26 additions and 26 deletions.
diff --git a/docs/learn/credentials.md → docs/learn/concepts/credentials.md b/docs/learn/credentials.md → docs/learn/concepts/credentials.md
diff --git a/docs/learn/ecosystems.md → docs/learn/concepts/ecosystems.md b/docs/learn/ecosystems.md → docs/learn/concepts/ecosystems.md
diff --git a/docs/learn/standards.md → docs/learn/concepts/standards.md b/docs/learn/standards.md → docs/learn/concepts/standards.md
diff --git a/docs/learn/trust-registries.md → docs/learn/concepts/trust-registries.md b/docs/learn/trust-registries.md → docs/learn/concepts/trust-registries.md
diff --git a/docs/learn/index.md b/docs/learn/index.md
@@ -1,4 +1,3 @@
 # Learn
 
-Understand the [key concepts](./intro.md) involved when using Trinsic, or work through our [tutorials](../walkthroughs/vaccination.md) to learn how to build out specific functionality.
-
+Understand the [key concepts](./intro.md) of self-sovereign identity, learn about the specifics of working with the [Trinsic platform](./platform/intro.md), or work through our [tutorials](../walkthroughs/vaccination.md) to learn how to build out specific functionality.
diff --git a/docs/learn/intro.md → docs/learn/platform/intro.md b/docs/learn/intro.md → docs/learn/platform/intro.md
diff --git a/docs/learn/security.md → docs/learn/platform/security.md b/docs/learn/security.md → docs/learn/platform/security.md
diff --git a/docs/learn/templates.md → docs/learn/platform/templates.md b/docs/learn/templates.md → docs/learn/platform/templates.md
diff --git a/docs/learn/wallets.md → docs/learn/platform/wallets.md b/docs/learn/wallets.md → docs/learn/platform/wallets.md
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -6,7 +6,7 @@ When using the SDK, you can pass parameters to the default service constructors
 
 ## Authorization
 
-See our [security](../learn/security.md) section for more information on how we have implemented wallet authentication and authorization.
+See our [security](../learn/platform/security.md) section for more information on how we have implemented wallet authentication and authorization.
 <!-- ### Profile Data Format -->
 
 ## SDK Services

diff --git a/docs/reference/services/account-service.md b/docs/reference/services/account-service.md
@@ -130,7 +130,7 @@ Returns the account information (name, email address, phone number, etc.) used t
 {{ proto_method_tabs("services.account.v1.Account.Info") }}
 
 !!! note
-    This call returns the information associated with the authentication token used to create the request; therefore, it is not possible to pass a different authentication token to this call. Otherwise, Trinsic's [zero-knowledge proof](/learn/security) authentication scheme would be violated.
+    This call returns the information associated with the authentication token used to create the request; therefore, it is not possible to pass a different authentication token to this call. Otherwise, Trinsic's [zero-knowledge proof](/learn/platform/security) authentication scheme would be violated.
 
     When using the CLI, this will return information for the account most recently logged in to.
 

diff --git a/docs/reference/services/credential-service.md b/docs/reference/services/credential-service.md
@@ -1,6 +1,6 @@
 # Credential Service
 
-The Credential Service exposes functionality for issuance, proof generation, verification, and revocation of [Verifiable Credentials](/learn/credentials){target=_blank}.
+The Credential Service exposes functionality for issuance, proof generation, verification, and revocation of [Verifiable Credentials](/learn/concepts/credentials){target=_blank}.
 
 
 !!! info "Signature Format" 

diff --git a/docs/reference/services/template-service.md b/docs/reference/services/template-service.md
@@ -1,7 +1,7 @@
 
 # Template Service
 
-The Template Service allows you to manage and search [Credential Templates](/learn/templates).
+The Template Service allows you to manage and search [Credential Templates](/learn/platform/templates).
 
 
 !!! info "Templates are optional"

diff --git a/docs/reference/services/trust-registry-service.md b/docs/reference/services/trust-registry-service.md
@@ -1,6 +1,6 @@
 # Trust Registry Service
 
-The Trust Registry Service exposes functionality for managing [Trust Registries](/learn/trust-registries) -- lists of authorized issuers for the various credential types within an ecosystem.
+The Trust Registry Service exposes functionality for managing [Trust Registries](/learn/concepts/trust-registries) -- lists of authorized issuers for the various credential types within an ecosystem.
 
 !!! warning "Under Construction"
     This section -- and the underlying API -- is under active development.

diff --git a/docs/reference/services/wallet-service.md b/docs/reference/services/wallet-service.md
@@ -69,7 +69,7 @@ Stores a credential (or any other JSON object) in a wallet.
 
 !!! question "What can be stored in a wallet?"
 
-    Wallets are mainly intended to hold [Verifiable Credentials](/learn/credentials){target=_blank}, but can technically
+    Wallets are mainly intended to hold [Verifiable Credentials](/learn/concepts/credentials){target=_blank}, but can technically
     store any JSON blob.
 
     If you store a Verifiable Credential in a Wallet, ensure that its `item_type` is `VerifiableCredential`.

diff --git a/docs/walkthroughs/vaccination.md b/docs/walkthroughs/vaccination.md
@@ -52,7 +52,7 @@ You can follow along using one of our SDKs, or use the Trinsic CLI, which implem
 
 ## Create an Ecosystem
 
-The first step is to create an [ecosystem](/learn/ecosystems/), within which everything else (wallets, templates, and credentials) will live.
+The first step is to create an [ecosystem](/learn/concepts/ecosystems/), within which everything else (wallets, templates, and credentials) will live.
 
 === "Trinsic CLI"
     ```
@@ -173,7 +173,7 @@ Once we've created our ecosystem, we need to configure our SDK client (or CLI) t
 
 !!! info "Further Reading: Ecosystems"
 
-    - Learn more about [Ecosystems](/learn/ecosystems){target=_blank}
+    - Learn more about [Ecosystems](/learn/concepts/ecosystems){target=_blank}
     - Browse the [Provider API reference](/reference/services/provider-service/){target=_blank}
 
 ## Create Accounts
@@ -261,15 +261,15 @@ The clinic's account will **issue** the credential, Allison's account will **hol
     Note that accounts are tied to their ecosystem. If you create an account tied to `bob@example.com` in the `example1` ecosystem, it will not be visible in any other ecosystem. The same email address can be used to create accounts in multiple ecosystems.
 
 !!! abstract "Further Reading: Accounts and Wallets"
-    - Learn more about [Wallets](../learn/wallets.md){target=_blank}
+    - Learn more about [Wallets](/learn/platform/wallets.md){target=_blank}
     - Browse the [Account API reference](/reference/services/account-service/){target=_blank}
-    - Read about [authentication tokens and security](/learn/security/){target=_blank}
+    - Read about [authentication tokens and security](/learn/platform/security/){target=_blank}
 
 ---
 
 ## Define a Template
 
-Before we can issue a credential, we need to create a [Template](/learn/templates/){target=_blank} for it. 
+Before we can issue a credential, we need to create a [Template](/learn/platform/templates/){target=_blank} for it. 
 
 Templates are simply a list of the fields that a credential can have.
 
@@ -358,7 +358,7 @@ Templates are simply a list of the fields that a credential can have.
 
 !!! abstract "Further Reading: Templates"
 
-    - Learn more about [Templates](/learn/templates){target=_blank}
+    - Learn more about [Templates](/learn/platform/templates){target=_blank}
     - Browse the [Template API reference](/reference/services/template-service/){target=_blank}
 
 ---
@@ -437,7 +437,7 @@ To issue a vaccine certificate, we'll use the template we created in the last st
 
 !!! abstract "Further Reading: Issuance and Credentials"
 
-    - Learn more about [Verifiable Credentials](/learn/credentials/){target=_blank}
+    - Learn more about [Verifiable Credentials](/learn/concepts/credentials/){target=_blank}
     - Browse the [Credential API reference](/reference/services/credential-service/){target=_blank}
 
 
@@ -515,7 +515,7 @@ Once Allison receives the credential, it must be stored in her wallet.
 The response to this call contains an Item ID; copy this down.
 
 !!! abstract "Further Reading: Wallets"
-    - Learn more about [Wallets](/learn/wallets/){target=_blank}
+    - Learn more about [Wallets](/learn/platform/wallets/){target=_blank}
     - Browse the [Wallet API reference](/reference/services/wallet-service/){target=_blank}
 
 
@@ -685,4 +685,4 @@ Congratulations! If you've completed all the steps of this walkthrough, you've j
 
 - Try out a [sample app](https://github.com/trinsic-id/sdk-examples){target=_blank}
 - Browse the [Service Reference](/reference/){target=_blank}
-- [Read more](/learn/intro/){target=_blank} about the key concepts and technologies at play
+- [Learn more](/learn){target=_blank} about the key concepts and technologies at play
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,17 +11,18 @@ nav:
   - Learn: 
     - Overview: learn/index.md
     - Key Concepts:
-      - What is Trinsic?: learn/intro.md
-      - Security Overview: learn/security.md
-      - Identity Ecosystems: learn/ecosystems.md
-      - Wallets: learn/wallets.md
-      - Templates: learn/templates.md
-      - Credentials: learn/credentials.md
-      - Trust Registries: learn/trust-registries.md
-      - Standards: learn/standards.md
+      - Identity Ecosystems: learn/concepts/ecosystems.md
+      - Credentials: learn/concepts/credentials.md
+      - Trust Registries: learn/concepts/trust-registries.md
+      - Standards: learn/concepts/standards.md
+    - Trinsic Platform:
+      - What is Trinsic?: learn/platform/intro.md
+      - Security Overview: learn/platform/security.md
+      - Templates: learn/platform/templates.md
+      - Wallets: learn/platform/wallets.md
     - Tutorials:
       - Build a Vaccine Card: walkthroughs/vaccination.md
-  - Services:
+  - Reference:
     - Overview: reference/index.md
     - SDK Services:
       - Account Service: reference/services/account-service.md