Skip to content

Commit c65b9cd

Browse files
committed
Add initial documentation for iExec Toolkit, What is iExec, and What is a Workerpool
- Created a new page for the iExec Toolkit, outlining essential tools and resources. - Added a comprehensive overview of iExec, detailing its mission, core architecture, and key features. - Introduced a placeholder for the Workerpool documentation, indicating that further details will be added.
1 parent efaa175 commit c65b9cd

File tree

7 files changed

+120
-42
lines changed

7 files changed

+120
-42
lines changed

.vitepress/sidebar.ts

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,12 @@ export function getSidebar() {
106106
text: 'PROTOCOL',
107107
items: [
108108
{
109-
text: '💸 Pay Per Task Model',
110-
link: '/get-started/protocol/poco/pay-per-task',
109+
text: '🛡️ Proof of Contribution',
110+
link: '/get-started/protocol/proof-of-contribution',
111111
},
112112
{
113-
text: '🛡️ Proof of Contribution',
114-
link: '/get-started/protocol/poco/proof-of-contribution',
113+
text: '💸 Pay Per Task Model',
114+
link: '/get-started/protocol/pay-per-task',
115115
},
116116
{
117117
text: '⚙️ Workers & Workerpools',
@@ -136,15 +136,15 @@ export function getSidebar() {
136136
items: [
137137
{
138138
text: 'Manage Access',
139-
link: '/guides/manage-data/guides/manage-access',
139+
link: '/guides/manage-data/manage-access',
140140
},
141141
{
142142
text: 'Handle Schemas and Dataset Types',
143-
link: '/guides/manage-data/guides/handle-schemas-dataset-types',
143+
link: '/guides/manage-data/handle-schemas-dataset-types',
144144
},
145145
{
146146
text: 'Monetize Protected Data',
147-
link: '/guides/manage-data/guides/monetize-protected-data',
147+
link: '/guides/manage-data/monetize-protected-data',
148148
},
149149
],
150150
},
@@ -293,89 +293,89 @@ export function getSidebar() {
293293
items: [
294294
{
295295
text: 'Collection',
296-
link: '/references/manage-data/dataProtector/dataProtectorSharing/collection',
296+
link: '/references/dataProtector/dataProtectorSharing/collection',
297297
collapsed: true,
298298
items: [
299299
{
300300
text: 'createCollection',
301-
link: '/references/manage-data/dataProtector/dataProtectorSharing/collection/createCollection',
301+
link: '/references/dataProtector/dataProtectorSharing/collection/createCollection',
302302
},
303303
{
304304
text: 'removeCollection',
305-
link: '/references/manage-data/dataProtector/dataProtectorSharing/collection/removeCollection',
305+
link: '/references/dataProtector/dataProtectorSharing/collection/removeCollection',
306306
},
307307
{
308308
text: 'addToCollection',
309-
link: '/references/manage-data/dataProtector/dataProtectorSharing/collection/addToCollection',
309+
link: '/references/dataProtector/dataProtectorSharing/collection/addToCollection',
310310
},
311311
{
312312
text: 'removeProtectedDataFromCollection',
313-
link: '/references/manage-data/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection',
313+
link: '/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection',
314314
},
315315
],
316316
},
317317
{
318318
text: 'Renting',
319-
link: '/references/manage-data/dataProtector/dataProtectorSharing/renting',
319+
link: '/references/dataProtector/dataProtectorSharing/renting',
320320
collapsed: true,
321321
items: [
322322
{
323323
text: 'setProtectedDataToRenting',
324-
link: '/references/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting',
324+
link: '/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting',
325325
},
326326
{
327327
text: 'setProtectedDataRentingParams',
328-
link: '/references/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams',
328+
link: '/references/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams',
329329
},
330330
{
331331
text: 'rentProtectedData',
332-
link: '/references/manage-data/dataProtector/dataProtectorSharing/renting/rentProtectedData',
332+
link: '/references/dataProtector/dataProtectorSharing/renting/rentProtectedData',
333333
},
334334
{
335335
text: 'removeProtectedDataFromRenting',
336-
link: '/references/manage-data/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting',
336+
link: '/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting',
337337
},
338338
],
339339
},
340340
{
341341
text: 'Selling',
342-
link: '/references/manage-data/dataProtector/dataProtectorSharing/selling',
342+
link: '/references/dataProtector/dataProtectorSharing/selling',
343343
collapsed: true,
344344
items: [
345345
{
346346
text: 'setProtectedDataForSale',
347-
link: '/references/manage-data/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale',
347+
link: '/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale',
348348
},
349349
{
350350
text: 'buyProtectedData',
351-
link: '/references/manage-data/dataProtector/dataProtectorSharing/selling/buyProtectedData',
351+
link: '/references/dataProtector/dataProtectorSharing/selling/buyProtectedData',
352352
},
353353
{
354354
text: 'removeProtectedDataForSale',
355-
link: '/references/manage-data/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale',
355+
link: '/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale',
356356
},
357357
],
358358
},
359359
{
360360
text: 'Subscription',
361-
link: '/references/manage-data/dataProtector/dataProtectorSharing/subscription',
361+
link: '/references/dataProtector/dataProtectorSharing/subscription',
362362
collapsed: true,
363363
items: [
364364
{
365365
text: 'setProtectedDataToSubscription',
366-
link: '/references/manage-data/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription',
366+
link: '/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription',
367367
},
368368
{
369369
text: 'setSubscriptionParams',
370-
link: '/references/manage-data/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams',
370+
link: '/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams',
371371
},
372372
{
373373
text: 'subscribeToCollection',
374-
link: '/references/manage-data/dataProtector/dataProtectorSharing/subscription/subscribeToCollection',
374+
link: '/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection',
375375
},
376376
{
377377
text: 'removeProtectedDataFromSubscription',
378-
link: '/references/manage-data/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription',
378+
link: '/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription',
379379
},
380380
],
381381
},
@@ -385,7 +385,7 @@ export function getSidebar() {
385385
items: [
386386
{
387387
text: 'consumeProtectedData',
388-
link: '/references/manage-data/dataProtector/dataProtectorSharing/consume/consumeProtectedData',
388+
link: '/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData',
389389
},
390390
],
391391
},
@@ -395,27 +395,27 @@ export function getSidebar() {
395395
items: [
396396
{
397397
text: 'getProtectedDataInCollections',
398-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections',
398+
link: '/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections',
399399
},
400400
{
401401
text: 'getProtectedDataPricingParams',
402-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams',
402+
link: '/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams',
403403
},
404404
{
405405
text: 'getCollectionOwners',
406-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getCollectionOwners',
406+
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionOwners',
407407
},
408408
{
409409
text: 'getCollectionsByOwner',
410-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getCollectionsByOwner',
410+
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner',
411411
},
412412
{
413413
text: 'getCollectionSubscriptions',
414-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions',
414+
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions',
415415
},
416416
{
417417
text: 'getRentals',
418-
link: '/references/manage-data/dataProtector/dataProtectorSharing/read/getRentals',
418+
link: '/references/dataProtector/dataProtectorSharing/read/getRentals',
419419
},
420420
],
421421
},
@@ -431,28 +431,28 @@ export function getSidebar() {
431431
items: [
432432
{
433433
text: 'Advanced Configuration',
434-
link: '/references/manage-data/dataProtector/advanced/advanced-configuration',
434+
link: '/references/dataProtector/advanced/advanced-configuration',
435435
},
436436
{
437437
text: 'Sharing smart contract',
438-
link: '/references/manage-data/dataProtector/advanced/dps-smart-contract',
438+
link: '/references/dataProtector/advanced/dps-smart-contract',
439439
},
440440
{
441441
text: 'Apps whitelist',
442-
link: '/references/manage-data/dataProtector/advanced/apps-whitelist',
442+
link: '/references/dataProtector/advanced/apps-whitelist',
443443
collapsed: true,
444444
items: [
445445
{
446446
text: 'createAddOnlyAppWhitelist',
447-
link: '/references/manage-data/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist',
447+
link: '/references/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist',
448448
},
449449
{
450450
text: 'addAppToAddOnlyAppWhitelist',
451-
link: '/references/manage-data/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist',
451+
link: '/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist',
452452
},
453453
{
454454
text: 'getUserAddOnlyAppWhitelist',
455-
link: '/references/manage-data/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist',
455+
link: '/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist',
456456
},
457457
],
458458
},
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: What is iExec?
3+
description:
4+
Learn about iExec, the decentralized computing platform that enables
5+
privacy-preserving applications
6+
---
7+
8+
# What is iExec?
9+
10+
iExec is a **decentralized computing platform** that enables developers to build
11+
and deploy privacy-preserving applications using confidential computing
12+
technology.
13+
14+
## 🎯 **Mission**
15+
16+
iExec's mission is to democratize access to **confidential computing** by
17+
providing a decentralized infrastructure that combines:
18+
19+
- **🔐 Privacy Protection** - Data remains encrypted during computation
20+
- **⚡ Scalable Computing** - Access to distributed computing resources
21+
- **💰 Monetization** - Fair compensation for computing providers
22+
- **🌐 Decentralization** - No single point of failure or control
23+
24+
## 🏗️ **Core Architecture**
25+
26+
### **Three Main Components:**
27+
28+
1. **🤖 iApps (iExec Applications)**
29+
- Confidential computing applications
30+
- Run in secure enclaves (TEEs)
31+
- Process encrypted data without exposing it
32+
33+
2. **🔐 DataProtector**
34+
- End-to-end encryption solution
35+
- Manage data access and sharing
36+
- Monetize protected datasets
37+
38+
3. **⚙️ Worker Network**
39+
- Distributed computing providers
40+
- Execute iApps securely
41+
- Earn RLC tokens for contributions
42+
43+
## 🚀 **Key Features**
44+
45+
- **TEE (Trusted Execution Environment)** support
46+
- **Zero-knowledge computation**
47+
- **Decentralized marketplace** for computing resources
48+
- **RLC token** for payments and governance
49+
- **Cross-chain compatibility**
50+
51+
## 🔗 **Get Started**
52+
53+
Ready to explore iExec? Check out:
54+
55+
- [What is Protected Data?](/get-started/overview/what-is-protected-data)
56+
- [What is an iApp?](/get-started/overview/what-is-iapp)
57+
- [Hello World Tutorial](/get-started/helloWorld)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: What is a Workerpool?
3+
description:
4+
Learn about workerpools in iExec - the computing resources that execute iApps
5+
---
6+
7+
# What is a Workerpool?
8+
9+
This page is under development.
10+
11+
<!-- TODO: Add comprehensive explanation of workerpools in iExec -->

src/get-started/toolkit.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: iExec Toolkit
3+
description: Essential tools and resources for building on iExec
4+
---
5+
6+
# 🛠️ iExec Toolkit
7+
8+
This page is under development.
9+
10+
<!-- TODO: Add comprehensive toolkit overview -->

src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ features:
4949
details:
5050
Deep dive into the core concepts of the protocol and understand how iExec
5151
enables privacy, governance, and monetization
52-
link: /references/sdk
52+
link: /get-started/protocol/proof-of-contribution
5353
---

src/references/dataProtector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
powered by blockchain technology.
77
---
88

9-
# 🔐 DataProtector <span style="margin-left: 12px; position: absolute; top: -2px;"><Badge type="tip" text="2.0.0" /> <Badge type="warning" text="beta" /></span>
9+
# 🔐 DataProtector <span style="margin-left: 12px; position: absolute; top: -2px;"><Badge type="tip" text="2.0.0" /></span>
1010

1111
DataProtector **simplifies secure data management**, offering users essential
1212
tools for protecting, managing, and sharing their data effectively.

src/references/dataProtector/migrate-from-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
the latest npm package
66
---
77

8-
# Migrate from V1 to V2 <span style="margin-left: 12px; position: absolute; top: -2px;"><Badge type="warning" text="beta" /></span>
8+
# Migrate from V1 to V2 <span style="margin-left: 12px; position: absolute; top: -2px;"></span>
99

1010
::: tip
1111

0 commit comments

Comments
 (0)