Skip to content

Commit eb7965d

Browse files
authored
refactor: Rework the 'Introduction' & 'Getting Started' page (#89)
1 parent 11f2f8c commit eb7965d

File tree

17 files changed

+93
-314
lines changed

17 files changed

+93
-314
lines changed

.vitepress/sidebar.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,6 @@ export function getSidebar() {
188188
{
189189
text: 'USE AN iAPP',
190190
items: [
191-
{
192-
text: 'Introduction',
193-
link: '/guides/use-iapp/introduction',
194-
},
195-
{
196-
text: 'Getting Started',
197-
link: '/guides/use-iapp/getting-started',
198-
},
199191
{
200192
text: 'How to Pay the Executions',
201193
link: '/guides/use-iapp/how-to-pay-executions',
379 KB
Loading

src/assets/use-iapp/iexec-actors-diagram.svg

Lines changed: 0 additions & 103 deletions
This file was deleted.

src/get-started/overview/what-is-iexec.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,37 @@ developers build privacy-preserving apps.
1212

1313
## SpeedRun The Protocol
1414

15-
### Step 1: Protect Data
15+
![iExec Deal Lifecycle](/assets/overview/deal-lifecycle.png)
1616

17-
Your sensitive data gets encrypted and stored online. Only you control who can
18-
access it.
17+
### Step 1: Prepare Resources
1918

20-
**DevTool**: [DataProtector](/references/dataProtector) handles this for you
19+
- **Data Provider** protects sensitive data with encryption and sets access
20+
rules.
21+
-**DevTool**: [DataProtector](/references/dataProtector)
22+
- **App Provider** deploys an iApp to process data securely.
23+
-**DevTool**: [iApp Generator](/references/iapp-generator)
2124

22-
### Step 2: Secure Computing (Workers)
25+
### Step 2: Create a Deal
2326

24-
Code runs inside **secure enclaves** (Trusted Execution Environments - TEEs) on
25-
iExec workers. The worker can access your data to process it, but only within
26-
the privacy-safe TEE environment - your data never leaves the secure bubble.
27+
**Requester** submits a computation request. The **PoCo smart contract**
28+
automatically matches and brings together all required resources: the iApp,
29+
protected data, and available workerpool.
2730

28-
### Step 3: Run iApp
31+
**Guides**:
32+
[Run iApp with ProtectedData](/guides/use-iapp/run-iapp-with-ProtectedData),
33+
[Run iApp without ProtectedData](/guides/use-iapp/run-iapp-without-ProtectedData)
2934

30-
You submit a **Task** = "Run this iApp on this protected data". The protocol
31-
finds available workers and executes everything confidentially.
35+
### Step 3: Execute in TEE
3236

33-
**DevTool**: [iApp Generator](/references/iapp-generator) helps you create and
34-
deploy iApp
37+
**Workers** from the selected workerpool download the iApp and execute it inside
38+
**secure enclaves** (TEEs). Your data is processed confidentially - workers can
39+
run computations but never access raw data outside the TEE.
3540

36-
### Step 4: Get Results
41+
### Step 4: Deliver Results & Pay
3742

38-
Results come back **encrypted to you**. Workers never see raw data, you never
39-
lose control.
40-
41-
```
42-
Protected Data + iApp + Worker = Task → Encrypted Result
43-
```
43+
Results are encrypted and delivered back to the requester. **RLC tokens** are
44+
automatically distributed to all participants (app provider, data provider,
45+
workerpool) based on their contribution.
4446

4547
## What each piece does
4648

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/build-&-test.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,28 @@ iApp Generator handles all the low-level complexity for you.
2929

3030
## Prerequisites
3131

32-
Before getting started, make sure you have the required tools installed. See the
33-
[iApp Generator Getting Started guide](/references/iapp-generator/getting-started)
34-
for detailed prerequisites and installation instructions.
32+
First, install iApp Generator in your project (for more details see
33+
[iApp Generator Getting Started](/references/iapp-generator/getting-started)):
34+
35+
::: code-group
36+
37+
```bash [npm]
38+
npm install -g @iexec/iapp-generator
39+
```
40+
41+
```bash [yarn]
42+
yarn global add @iexec/iapp-generator
43+
```
44+
45+
```bash [pnpm]
46+
pnpm add -g @iexec/iapp-generator
47+
```
48+
49+
```bash [bun]
50+
bun add -g @iexec/iapp-generator
51+
```
52+
53+
:::
3554

3655
## Quick Start
3756

src/guides/build-iapp/inputs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ within the TEE environment.
2727
::: tip
2828

2929
You can also execute iApp outside of DataProtector using other methods. See the
30-
[Use an iApp guide](/guides/use-iapp/introduction) for more information.
30+
[Run iApp without ProtectedData](/guides/use-iapp/run-iapp-without-ProtectedData)
31+
guide for more information.
3132

3233
:::
3334

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

0 commit comments

Comments
 (0)