Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split Key Concepts into Key Concepts and Trinsic Platform; rename Services to Reference #788

Merged
merged 1 commit into from
Jun 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions docs/learn/index.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/account-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/credential-service.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/template-service.md
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/trust-registry-service.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/wallet-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
18 changes: 9 additions & 9 deletions docs/walkthroughs/vaccination.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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}

---
Expand Down Expand Up @@ -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}


Expand Down Expand Up @@ -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}


Expand Down Expand Up @@ -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
19 changes: 10 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down