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

fix: links and references to Atala in the quick-start.md guide #95

Closed
wants to merge 6 commits into from
Closed
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
26 changes: 13 additions & 13 deletions documentation/docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ More in depth documentation about [Cloud Agent](/docs/concepts/glossary/#cloud-a



### Wallet SDKs
[Wallet SDKs](/docs/concepts/glossary/#wallet-sdk) for web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests. They are typically used in applications that allow identity holders to interact with issuers and verifiers.
### Edge Agent SDKs
[Edge Agent SDKs](/docs/concepts/glossary/#wallet-sdk) for web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests. They are typically used in applications that allow identity holders to interact with issuers and verifiers.

More in-depth documentation about the different Wallet SDKs can be found here ([TypeScript](https://input-output-hk.github.io/atala-prism-wallet-sdk-ts/), [Swift](https://input-output-hk.github.io/atala-prism-wallet-sdk-swift/), [KMM](https://input-output-hk.github.io/atala-prism-wallet-sdk-kmm/))
More in-depth documentation about the different Edge Agent SDKs can be found here ([TypeScript](https://input-output-hk.github.io/atala-prism-wallet-sdk-ts/), [Swift](https://input-output-hk.github.io/atala-prism-wallet-sdk-swift/), [KMM](https://input-output-hk.github.io/atala-prism-wallet-sdk-kmm/))



### A Mediator
[Mediators](/docs/concepts/glossary/#mediator) are for storing and relaying messages between Cloud Agents and Wallet SDKs. They act as a proxy that remains connected to the network and receives any message, credential, or proof request on behalf of the Wallet SDKs (which can be offline occasionally).
[Mediators](/docs/concepts/glossary/#mediator) are for storing and relaying messages between Cloud Agents and Edge Agent SDKs. They act as a proxy that remains connected to the network and receives any message, credential, or proof request on behalf of the Edge Agent SDKs (which can be offline occasionally).

More in-depth documentation about Mediator can be found [here](/docs/identus/mediator).

Expand Down Expand Up @@ -256,7 +256,7 @@ curl -X 'POST' \


### Starting Sample App
All wallet SDK's come bundled with a sample application, that cover all the Identus flows, including establishing connections, issuance, and verification flows.
All Edge Agent SDK's come bundled with a sample application, that cover all the Identus flows, including establishing connections, issuance, and verification flows.

<Tabs>
<TabItem value="js" label="Typescript Sample APP">
Expand Down Expand Up @@ -295,7 +295,7 @@ npm i
npm run start
```

* This will start the react Wallet SDK TypeScript Demonstration at [http://localhost:3000](http://localhost:3000).
* This will start the react Edge Agent SDK TypeScript Demonstration at [http://localhost:3000](http://localhost:3000).

</TabItem>
<TabItem value="swift" label="Swift Sample APP">
Expand All @@ -309,7 +309,7 @@ git clone https://github.com/input-output-hk/identus-edge-agent-sdk-swift
2. Open the XCode project on __./Sample/AtalaPrismWalletDemo/AtalaPrismWalletDemo.xcodeproj__
3. On the top left of the XCode window you will see a play/run button, press it.
4. The app will start.
5. Click Wallet Demo 2.0
5. Click Edge Agent Demo 2.0
* You will be able to run the rest of the guide here.

</TabItem>
Expand All @@ -321,7 +321,7 @@ git clone https://github.com/input-output-hk/identus-edge-agent-sdk-swift
git clone https://github.com/input-output-hk/identus-edge-agent-sdk-kmm
```

2. Open the Wallet SDK project on IntelliJ or Android Studio.
2. Open the Edge Agent SDK project on IntelliJ or Android Studio.
3. In the `Run configuration` dropdown, select SampleApp.
4. Select the device or emulator you want to use.
5. Click "Run".
Expand All @@ -331,7 +331,7 @@ git clone https://github.com/input-output-hk/identus-edge-agent-sdk-kmm
</Tabs>

### Deploy & Establish Mediation
Mediation is the process that ensures messages get routed and stored correctly between Issuers, Verifiers and Holders, even if they are offline. The mediator offers a service that is always running and can securely store messages and deliver them to the associated DIDs using DIDComm. This enables use-cases where connectivity to a (mobile) wallet cannot be guaranteed.
Mediation is the process that ensures messages get routed and stored correctly between Issuers, Verifiers and Holders, even if they are offline. The mediator offers a service that is always running and can securely store messages and deliver them to the associated DIDs using DIDComm. This enables use-cases where connectivity to a (mobile) Edge Agent cannot be guaranteed.

#### Preparation
1. To get the mediator deployed locally for the demo, clone the [Mediator repository](https://github.com/input-output-hk/identus-mediator).
Expand Down Expand Up @@ -385,7 +385,7 @@ Follow the steps in your desired platform as stated below:

<TabItem value="swift" label="Swift Sample APP">

1. In the app, go to Wallet Demo, and on the Mediator tab, insert the mediator DID.
1. In the app, go to Edge Agent Demo, and on the Mediator tab, insert the mediator DID.

</TabItem>
<TabItem value="android" label="Android Sample APP">
Expand Down Expand Up @@ -507,7 +507,7 @@ curl --location \
}'
```

1. This request will return a JSON response with an invitation and its URL. The Issuer Cloud Agent would share this URL as a QR code, and the holder would scan it with the wallet app.
1. This request will return a JSON response with an invitation and its URL. The Issuer Cloud Agent would share this URL as a QR code, and the holder would scan it with the Edge Agent app.

* Copy the `invitationUrl` and the `connectionId`.

Expand All @@ -521,7 +521,7 @@ curl --location \
}'
```

2. This request will return a JSON response with an invitation and its URL. The Verifier Cloud Agent would share this URL as a QR code, and the holder would scan it with the wallet app.
2. This request will return a JSON response with an invitation and its URL. The Verifier Cloud Agent would share this URL as a QR code, and the holder would scan it with the Edge Agent app.

* Copy the `invitationUrl` and the `connectionId`.

Expand Down Expand Up @@ -956,4 +956,4 @@ curl --location \
--header 'Accept: application/json'
```

7. The response body establishes the completion of the request and can be verified for correctness.
7. The response body establishes the completion of the request and can be verified for correctness.
2 changes: 1 addition & 1 deletion documentation/docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ const sidebars = {
],
};

module.exports = sidebars;
module.exports = sidebars;
6 changes: 3 additions & 3 deletions src/components/resources/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,19 +126,19 @@ const RESOURCES = [
linkTo: "/tutorials"
},
{
title: "Wallet SDK Swift",
title: "Edge Agent SDK Swift",
Svg: Graphics.walletSdkSwift,
content: "Build Swift-based applications using our SDKs",
linkTo: "https://input-output-hk.github.io/atala-prism-wallet-sdk-swift/"
},
{
title: "Wallet SDK TypeScript",
title: "Edge Agent SDK TS",
Svg: Graphics.walletSdkTS,
content: "Build web-based applications using our SDKs",
linkTo: "#"
},
{
title: "Wallet SDK KMM",
title: "Edge Agent SDK KMM",
Svg: Graphics.walletSdkKmm,
content: "Build KMM-based applications using our SDKs",
linkTo: "https://input-output-hk.github.io/atala-prism-wallet-sdk-kmm/"
Expand Down
Loading