Skip to content

Commit c1056e5

Browse files
committed
docs: update references to iExec SDK documentation across multiple guides for clarity and consistency
1 parent 708e4f5 commit c1056e5

File tree

7 files changed

+23
-16
lines changed

7 files changed

+23
-16
lines changed

src/guides/build-iapp/advanced/quick-start.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ test blockchain.
1818

1919
## Install the iExec SDK
2020

21+
For complete installation instructions and requirements, see the
22+
[iExec SDK documentation](/references/sdk).
23+
2124
Requirements:
2225
[![npm version](https://img.shields.io/badge/nodejs-%3E=18.0.0-brightgreen.svg)](https://nodejs.org/en/)
2326

src/guides/build-iapp/advanced/result-callback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ contract address.
106106
After completion, the protocol calls your contract, passing the `callback-data`
107107
bytes.
108108

109-
First install the iExec SDK if you have not already (see
110-
[Getting Started](/guides/use-iapp/getting-started)).
109+
First install the iExec SDK if you have not already (see the
110+
[iExec SDK documentation](/references/sdk)).
111111

112112
```ts twoslash
113113
import { IExec, utils } from 'iexec';

src/guides/build-iapp/manage-access.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Currently, order management is not yet available in iApp Generator. This guide
2828
shows you how to use the iExec SDK CLI to create and manage your app orders.
2929

3030
For complete SDK documentation, check the
31-
[iExec SDK GitHub repository](https://github.com/iExecBlockchainComputing/iexec-sdk).
31+
[iExec SDK documentation](/references/sdk).
3232

3333
:::
3434

@@ -67,7 +67,8 @@ Here's an example app order for a sentiment analysis iApp:
6767
### Step 1: Install the iExec SDK
6868

6969
Since iApp Generator doesn't handle orders yet, you need to use the iExec SDK
70-
CLI:
70+
CLI. For detailed installation instructions, see the
71+
[iExec SDK documentation](/references/sdk).
7172

7273
::: code-group
7374

@@ -304,8 +305,7 @@ Next steps:
304305

305306
### Technical deep dive
306307

307-
- **[iExec SDK Documentation](https://github.com/iExecBlockchainComputing/iexec-sdk)** -
308-
Complete CLI reference
308+
- **[iExec SDK Documentation](/references/sdk)** - Complete CLI reference
309309

310310
<script setup>
311311
import { computed } from 'vue';

src/guides/build-iapp/outputs.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,3 @@ Continue building with these guides:
145145
Control who can use your iApp
146146
- **[Debugging Your iApp](/guides/build-iapp/debugging)** - Troubleshoot
147147
execution issues
148-
- **[How to Get and Decrypt Results](/guides/use-iapp/getting-started)** -
149-
User-side result handling

src/guides/use-iapp/introduction.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ protected throughout the computation.
7979

8080
## Getting Started
8181

82-
Ready to start using iApp? Check out our
83-
[Getting Started Guide](/guides/use-iapp/getting-started) to learn how to find,
84-
execute, and interact with iApp on the iExec network.
82+
Ready to start using iApp? Check out our guides to learn how to find, execute,
83+
and interact with iApp on the iExec network:
84+
85+
- [Run iApp with ProtectedData](/guides/use-iapp/run-iapp-with-ProtectedData)
86+
- [Run iApp without ProtectedData](/guides/use-iapp/run-iapp-without-ProtectedData)

src/guides/use-iapp/run-iapp-without-ProtectedData.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ configuration to enable processing and customize functionality.
1616

1717
## Prerequisites
1818

19-
Before you begin, make sure you have the iExec SDK installed.
19+
Before you begin, make sure you have the iExec SDK installed. For detailed
20+
installation instructions, see the [iExec SDK documentation](/references/sdk).
2021

2122
::: code-group
2223

src/references/sdk.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,25 @@ system:
2222

2323
### Installation
2424

25+
For complete installation instructions and requirements, see the
26+
[iExec SDK documentation](https://github.com/iExecBlockchainComputing/iexec-sdk/blob/master/docs/README.md).
27+
2528
::: code-group
2629

2730
```sh [npm]
28-
npm install @iexec/dataprotector
31+
npm install iexec
2932
```
3033

3134
```sh [yarn]
32-
yarn add @iexec/dataprotector
35+
yarn add iexec
3336
```
3437

3538
```sh [pnpm]
36-
pnpm add @iexec/dataprotector
39+
pnpm add iexec
3740
```
3841

3942
```sh [bun]
40-
bun add @iexec/dataprotector
43+
bun add iexec
4144
```
4245

4346
:::

0 commit comments

Comments
 (0)