From 126b3b412d8d1e4145b7aa3093c10bc14752edf0 Mon Sep 17 00:00:00 2001 From: Mathis Debuire <68806646+64ix@users.noreply.github.com> Date: Thu, 14 Aug 2025 16:54:57 +0200 Subject: [PATCH 1/5] Refactor iApp, Protected Data, and Workerpool docs Renamed and updated overview pages for iApps, Protected Data, and Workerpools for clarity and consistency. Updated sidebar, internal links, and references to match new filenames and titles. Added detailed content for the Workerpools page and removed the placeholder Workerpool doc. Reworked the What is iExec page for a better tech explanation --- .vitepress/sidebar.ts | 12 +- README.md | 1 + .../overview/{what-is-iapp.md => iapps.md} | 4 +- ...is-protected-data.md => protected-data.md} | 10 +- src/get-started/overview/what-is-iexec.md | 104 +++++++---- .../overview/what-is-workerpool.md | 11 -- src/get-started/overview/workerpools.md | 166 ++++++++++++++++++ src/guides/build-iapp/index.md | 3 +- src/guides/use-iapp/getting-started.md | 2 +- src/index.md | 4 +- src/references/iapp-generator.md | 3 +- 11 files changed, 257 insertions(+), 63 deletions(-) rename src/get-started/overview/{what-is-iapp.md => iapps.md} (99%) rename src/get-started/overview/{what-is-protected-data.md => protected-data.md} (97%) delete mode 100644 src/get-started/overview/what-is-workerpool.md create mode 100644 src/get-started/overview/workerpools.md diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index e77aac5f..646b3445 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -60,16 +60,16 @@ export function getSidebar() { link: '/get-started/overview/what-is-iexec', }, { - text: '❓  What is Protected Data ?', - link: '/get-started/overview/what-is-protected-data', + text: '🔐 Protected Data', + link: '/get-started/overview/protected-data', }, { - text: '❓ What is an iApp ?', - link: '/get-started/overview/what-is-iapp', + text: '🚀 iApps', + link: '/get-started/overview/iapps', }, { - text: '❓ What is a Workerpool ?', - link: '/get-started/overview/what-is-workerpool', + text: '⚡ Workerpools', + link: '/get-started/overview/workerpools', }, { text: '🪙 RLC Token', diff --git a/README.md b/README.md index cedd359a..5f876f3c 100644 --- a/README.md +++ b/README.md @@ -192,3 +192,4 @@ for input parameters: - migrate github SDK doc here - migrate pay-per-task page into a guide - check pages (introduction & getting-started) for use-iapp guide +- Schema what is iexec to do and implement diff --git a/src/get-started/overview/what-is-iapp.md b/src/get-started/overview/iapps.md similarity index 99% rename from src/get-started/overview/what-is-iapp.md rename to src/get-started/overview/iapps.md index 06f051fe..00ff06fc 100644 --- a/src/get-started/overview/what-is-iapp.md +++ b/src/get-started/overview/iapps.md @@ -1,9 +1,9 @@ --- -title: What is an iApp? +title: iApps description: Privacy-first applications that run on decentralized infrastructure --- -# 🚀 What is an iApp? +# iApps An iExec Application (iApp) is your regular application code (Python script, AI model, data processor, ...) that can securely process protected data (created by diff --git a/src/get-started/overview/what-is-protected-data.md b/src/get-started/overview/protected-data.md similarity index 97% rename from src/get-started/overview/what-is-protected-data.md rename to src/get-started/overview/protected-data.md index b77571da..632ca453 100644 --- a/src/get-started/overview/what-is-protected-data.md +++ b/src/get-started/overview/protected-data.md @@ -1,9 +1,9 @@ --- -title: What is Protected Data? +title: Protected Data description: Understanding iExec's data protection mechanisms --- -# ❓ What is Protected Data? +# Protected Data Protected Data refers to any data encrypted using the **iExec Data Protector tool**. This end-to-end encryption solution enables users to protect, manage and @@ -15,7 +15,7 @@ monetize their data within the Web3 ecosystem. ## Key Concepts -### 👑 Data Governance +### Data Governance
@@ -42,7 +42,7 @@ monetize their data within the Web3 ecosystem. -### 🔒 Privacy-preserving Computation +### Privacy-preserving Computation
@@ -69,7 +69,7 @@ monetize their data within the Web3 ecosystem. -### 💰 Monetization +### Monetization
diff --git a/src/get-started/overview/what-is-iexec.md b/src/get-started/overview/what-is-iexec.md index 11f43eb5..3a230dce 100644 --- a/src/get-started/overview/what-is-iexec.md +++ b/src/get-started/overview/what-is-iexec.md @@ -11,47 +11,87 @@ iExec is a **decentralized computing platform** that enables developers to build and deploy privacy-preserving applications using confidential computing technology. -## 🎯 **Mission** +## The Protocol (Simple Version) -iExec's mission is to democratize access to **confidential computing** by -providing a decentralized infrastructure that combines: +### Step 1: Protect Data -- **🔐 Privacy Protection** - Data remains encrypted during computation -- **⚡ Scalable Computing** - Access to distributed computing resources -- **💰 Monetization** - Fair compensation for computing providers -- **🌐 Decentralization** - No single point of failure or control +Your sensitive data gets encrypted and stored online. Only you control who can +access it. -## 🏗️ **Core Architecture** +→ **Devtool**: [DataProtector](/references/dataProtector) handles this for you -### **Three Main Components:** +### Step 2: Secure Computing (Workers) -1. **🤖 iApps (iExec Applications)** - - Confidential computing applications - - Run in secure enclaves (TEEs) - - Process encrypted data without exposing it +Code runs inside **secure enclaves** (TEEs) on iExec workers. The worker can +access your data to process it, but only within the privacy-safe TEE +environment - your data never leaves the secure bubble. -2. **🔐 DataProtector** - - End-to-end encryption solution - - Manage data access and sharing - - Monetize protected datasets +### Step 3: Run iApps -3. **⚙️ Worker Network** - - Distributed computing providers - - Execute iApps securely - - Earn RLC tokens for contributions +You submit a **Task** = "Run this iApp on this protected data". The protocol +finds available workers and executes everything confidentially. -## 🚀 **Key Features** +→ **Devtool**: [iApp Generator](/references/iapp-generator) helps you create and +deploy iApps -- **TEE (Trusted Execution Environment)** support -- **Zero-knowledge computation** -- **Decentralized marketplace** for computing resources -- **RLC token** for payments and governance -- **Cross-chain compatibility** +### 📦 Step 4: Get Results -## 🔗 **Get Started** +Results come back **encrypted to you**. Workers never see raw data, you never +lose control. -Ready to explore iExec? Check out: +``` +Protected Data + iApp + Worker = Task → Encrypted Result +``` -- [What is Protected Data?](/get-started/overview/what-is-protected-data) -- [What is an iApp?](/get-started/overview/what-is-iapp) -- [Hello World Tutorial](/get-started/helloWorld) +## What Each Piece Does + +### **Protected Data** + +Your data, encrypted. You set the rules: "Only these apps can use it, only for +these purposes." + +### **iApps** + +Your code, packaged to run on workers. Can be AI models, data processing +scripts, any computation. + +### **Workers (Secure Enclaves)** + +Computers that process your data inside privacy-safe TEE environments. They can +access your data to work with it, but the TEE ensures it stays confidential and +tamper-proof. + +### **Deals** + +A job request: "Execute iApp X on protected data Y, send results to Z." The +protocol handles the rest. + +## Real Example Walkthrough + +**AI Model Training (Private)** + +1. **Protect**: Medical researchers upload patient data → becomes Protected Data +2. **Deploy**: AI company packages their model → becomes iApp +3. **Execute**: Someone submits Task → "Train model on this data" +4. **Result**: Model gets trained, researcher gets insights, raw data never + leaves enclave + +**Web3 Email** + +1. **Protect**: Users upload email contacts → Protected Data +2. **Execute**: App submits Task → "Send email via Web3Mail iApp" +3. **Result**: Email sent, addresses stay private, sender/receiver authenticated + +## Start Building + +Now that you get the protocol, pick your devtools: + +- **📧 Quick Win**: Add [Web3Mail](/references/web3mail) or + [Web3Telegram](/references/web3telegram) to your project ! (uses the protocol + under the hood) +- **🛡️ Protect Data**: Try [DataProtector](/references/dataProtector) to encrypt + your first dataset +- **🚀 Build iApps**: Create confidential compute with + [iApp Generator](/references/iapp-generator) +- **👋 Hands-On**: Follow our [Hello World](/get-started/helloWorld) to see all + devtools working together diff --git a/src/get-started/overview/what-is-workerpool.md b/src/get-started/overview/what-is-workerpool.md deleted file mode 100644 index 3ef69aa9..00000000 --- a/src/get-started/overview/what-is-workerpool.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: What is a Workerpool? -description: - Learn about workerpools in iExec - the computing resources that execute iApps ---- - -# What is a Workerpool? - -This page is under development. - - diff --git a/src/get-started/overview/workerpools.md b/src/get-started/overview/workerpools.md new file mode 100644 index 00000000..3cfb3209 --- /dev/null +++ b/src/get-started/overview/workerpools.md @@ -0,0 +1,166 @@ +--- +title: Workerpools +description: + Learn about workerpools in iExec - the computing resources that execute iApps +--- + +# Workerpools + +A **Workerpool** is a group of computing machines (workers) managed by a +**Workerpool Manager** that provides computational resources to execute iApps in +secure environments on the iExec network. + +
+

Think of workerpools as computing clusters where your iApps run. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.

+
+ +## Key Concepts + +### Workerpool Manager + +
+ +
+
+
+ • +
+ Resource Coordinator: Manages and organizes available computing resources +
+
+
+ • +
+ Task Scheduler: Distributes tasks among available workers +
+
+
+ • +
+ Network Interface: Connects the workerpool to the iExec marketplace +
+
+
+
+ +### Workers (Computing Machines) + +
+ +
+
+
+ • +
+ TEE-enabled Hardware: Machines equipped with Trusted Execution Environments +
+
+
+ • +
+ Task Execution: Run iApps and process protected data securely +
+
+
+ • +
+ RLC Rewards: Earn RLC tokens for successfully completed tasks +
+
+
+
+ +### Security & Privacy + +
+ +
+
+
+ • +
+ TEE Protection: All computations happen inside secure enclaves +
+
+
+ • +
+ Data Isolation: Protected data never leaves the secure environment +
+
+
+ • +
+ Proof of Contribution: Cryptographic verification of task completion +
+
+
+
+ +## How Workerpools Work + +
+
+
+ 1. +
+ Task Request: User submits a task to execute an iApp on protected data +
+
+
+ 2. +
+ Workerpool Selection: PoCo system matches request with available workerpool +
+
+
+ 3. +
+ Task Distribution: Workerpool manager assigns task to an available worker +
+
+
+ 4. +
+ Secure Execution: Worker downloads iApp and executes it in TEE environment +
+
+
+ 5. +
+ Result Delivery: Encrypted results are returned to the requester +
+
+
+
+ +## Getting Started + +
+

Want to use workerpools? Start building iApps and the protocol will handle workerpool selection automatically. Want to operate a workerpool? Check our deployment guides.

+
+ +## Next Steps + +
+
+
+ 🚀 +
+ Start Using: Build your first iApp and see workerpools in action +
+
+
+ ⚙️ +
+ Join as Worker: Contact us on Discord for guidance and support +
+
+
+ 🏭 +
+ Manage Workerpool: Contact us on Discord for deployment assistance +
+
+
+
diff --git a/src/guides/build-iapp/index.md b/src/guides/build-iapp/index.md index b9fc823a..25a4205a 100644 --- a/src/guides/build-iapp/index.md +++ b/src/guides/build-iapp/index.md @@ -35,8 +35,7 @@ After mastering these guides, explore: - **[iApp Generator](/references/iapp-generator)** - Complete development toolkit -- **[What is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and - TEE overview +- **[iApps](/get-started/overview/iapps)** - Core concepts and TEE overview Ready to build your first privacy-preserving application? Start with the [Build & Deploy](/guides/build-iapp/build-&-deploy) guide! diff --git a/src/guides/use-iapp/getting-started.md b/src/guides/use-iapp/getting-started.md index cbd9667e..9fbbaaf2 100644 --- a/src/guides/use-iapp/getting-started.md +++ b/src/guides/use-iapp/getting-started.md @@ -67,7 +67,7 @@ orders: When you execute an iApp, the system matches your request with available orders from all three categories. For a deeper understanding of how orders work and how to manage them, see the -[Build & Deploy guide](/build-iapp/guides/build-&-deploy) in the Build iApp +[Build & Deploy guide](/guides/build-iapp/build-&-deploy) in the Build iApp section. ## Detailed Guides diff --git a/src/index.md b/src/index.md index 8d7bf0ac..edfbd1d6 100644 --- a/src/index.md +++ b/src/index.md @@ -25,13 +25,13 @@ features: details: Secure your data with advanced encryption and control access while maintaining privacy using DataProtector - link: /get-started/overview/what-is-protected-data + link: /get-started/overview/protected-data - icon: 🤖 title: Build iApps details: Create decentralized applications that run on confidential computing infrastructure with our iApp Generator - link: /get-started/overview/what-is-iapp + link: /get-started/overview/iapps - icon: ⚡ title: Use iApps details: diff --git a/src/references/iapp-generator.md b/src/references/iapp-generator.md index 25990a96..7efb425f 100644 --- a/src/references/iapp-generator.md +++ b/src/references/iapp-generator.md @@ -41,8 +41,7 @@ minutes, not months. Start here to understand what iApps are and how they work: -- **[What Is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and - TEE overview +- **[iApps](/get-started/overview/iapps)** - Core concepts and TEE overview - **[Getting Started](/references/iapp-generator/getting-started)** - Your first iApp in 15 minutes - **[Building Your iApp](/references/iapp-generator/building-your-iexec-app)** - From 4c64db34fbdcaff4b0d1a56caeac050ebafae7ed Mon Sep 17 00:00:00 2001 From: Mathis Debuire <68806646+64ix@users.noreply.github.com> Date: Mon, 18 Aug 2025 14:30:37 +0200 Subject: [PATCH 2/5] Remove emojis --- .vitepress/sidebar.ts | 10 +++++----- src/get-started/overview/iapps.md | 12 ++++-------- src/get-started/overview/protected-data.md | 6 ------ src/get-started/overview/what-is-iexec.md | 10 +++++----- src/get-started/overview/workerpools.md | 3 --- 5 files changed, 14 insertions(+), 27 deletions(-) diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 646b3445..488ee611 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -56,23 +56,23 @@ export function getSidebar() { text: 'iExec OVERVIEW', items: [ { - text: '❓ What is iExec ?', + text: 'What is iExec ?', link: '/get-started/overview/what-is-iexec', }, { - text: '🔐 Protected Data', + text: 'Protected Data', link: '/get-started/overview/protected-data', }, { - text: '🚀 iApps', + text: 'iApps', link: '/get-started/overview/iapps', }, { - text: '⚡ Workerpools', + text: 'Workerpools', link: '/get-started/overview/workerpools', }, { - text: '🪙 RLC Token', + text: 'RLC Token', link: '/get-started/rlc', }, ], diff --git a/src/get-started/overview/iapps.md b/src/get-started/overview/iapps.md index 00ff06fc..c986e4e6 100644 --- a/src/get-started/overview/iapps.md +++ b/src/get-started/overview/iapps.md @@ -19,19 +19,15 @@ Imagine you want to build:
- 🤖 An AI that analyzes personal health data
- 📧 An email tool that needs access to contact lists
- 💰 A financial advisor that processes bank statements
- 🛡️ A content filter that reads private messages
@@ -101,19 +97,19 @@ guarantees** that privacy is preserved within the TEE execution environment.
-

🏥 Healthcare

+

Healthcare

Process medical data for AI diagnosis without exposing patient information

-

💰 Finance

+

Finance

Analyze financial data for credit scoring while maintaining privacy

-

🎬 Media

+

Media

Content recommendation engines that don't track user behavior

-

🔬 Research

+

Research

Collaborative research on sensitive datasets across institutions

diff --git a/src/get-started/overview/protected-data.md b/src/get-started/overview/protected-data.md index 632ca453..285e453a 100644 --- a/src/get-started/overview/protected-data.md +++ b/src/get-started/overview/protected-data.md @@ -138,7 +138,6 @@ monetize their data within the Web3 ecosystem.
- 👤

Personal Data

    @@ -150,7 +149,6 @@ monetize their data within the Web3 ecosystem.
    - 🏢

    Business Intelligence

      @@ -162,7 +160,6 @@ monetize their data within the Web3 ecosystem.
      - 🤖

      AI Training

        @@ -174,7 +171,6 @@ monetize their data within the Web3 ecosystem.
        - 🔬

        Research

          @@ -194,13 +190,11 @@ monetize their data within the Web3 ecosystem.
          - 📚
          - 🚀 diff --git a/src/get-started/overview/what-is-iexec.md b/src/get-started/overview/what-is-iexec.md index 3a230dce..73efe01a 100644 --- a/src/get-started/overview/what-is-iexec.md +++ b/src/get-started/overview/what-is-iexec.md @@ -34,7 +34,7 @@ finds available workers and executes everything confidentially. → **Devtool**: [iApp Generator](/references/iapp-generator) helps you create and deploy iApps -### 📦 Step 4: Get Results +### Step 4: Get Results Results come back **encrypted to you**. Workers never see raw data, you never lose control. @@ -86,12 +86,12 @@ protocol handles the rest. Now that you get the protocol, pick your devtools: -- **📧 Quick Win**: Add [Web3Mail](/references/web3mail) or +- **Quick Win**: Add [Web3Mail](/references/web3mail) or [Web3Telegram](/references/web3telegram) to your project ! (uses the protocol under the hood) -- **🛡️ Protect Data**: Try [DataProtector](/references/dataProtector) to encrypt +- **Protect Data**: Try [DataProtector](/references/dataProtector) to encrypt your first dataset -- **🚀 Build iApps**: Create confidential compute with +- **Build iApps**: Create confidential compute with [iApp Generator](/references/iapp-generator) -- **👋 Hands-On**: Follow our [Hello World](/get-started/helloWorld) to see all +- **Hands-On**: Follow our [Hello World](/get-started/helloWorld) to see all devtools working together diff --git a/src/get-started/overview/workerpools.md b/src/get-started/overview/workerpools.md index 3cfb3209..e3431ac9 100644 --- a/src/get-started/overview/workerpools.md +++ b/src/get-started/overview/workerpools.md @@ -145,19 +145,16 @@ secure environments on the iExec network.
          - 🚀
          Start Using: Build your first iApp and see workerpools in action
          - ⚙️
          Join as Worker: Contact us on Discord for guidance and support
          - 🏭
          Manage Workerpool: Contact us on Discord for deployment assistance
          From 446b50c650efcdeec1979bb4408c3c3c5835d1c3 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Mon, 18 Aug 2025 16:45:24 +0200 Subject: [PATCH 3/5] Refactor iApp and Workerpool terminology for consistency Updated references to "iApps" to "iApp" across documentation and sidebar for uniformity. Removed outdated iApps and Workerpools pages, consolidating content for clarity. Adjusted links and terminology in related files to reflect these changes. --- .../styles/config/vocabularies/Technical/accept.txt | 2 ++ .vitepress/sidebar.ts | 4 ++-- src/get-started/overview/{iapps.md => iapp.md} | 2 +- src/get-started/overview/what-is-iexec.md | 12 ++++++------ .../overview/{workerpools.md => workerpool.md} | 10 +++++----- src/references/iapp-generator.md | 2 +- 6 files changed, 17 insertions(+), 15 deletions(-) rename src/get-started/overview/{iapps.md => iapp.md} (99%) rename src/get-started/overview/{workerpools.md => workerpool.md} (90%) diff --git a/.github/styles/config/vocabularies/Technical/accept.txt b/.github/styles/config/vocabularies/Technical/accept.txt index 7812612a..4d877b20 100644 --- a/.github/styles/config/vocabularies/Technical/accept.txt +++ b/.github/styles/config/vocabularies/Technical/accept.txt @@ -125,8 +125,10 @@ ethereum intel nano workerpool +Workerpool protectedData dataProtector +DataProtector iApp sconification middleware diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 3b90649d..173f9fa8 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -64,8 +64,8 @@ export function getSidebar() { link: '/get-started/overview/protected-data', }, { - text: 'iApps', - link: '/get-started/overview/iapps', + text: 'iApp', + link: '/get-started/overview/iapp', }, { text: 'Workerpools', diff --git a/src/get-started/overview/iapps.md b/src/get-started/overview/iapp.md similarity index 99% rename from src/get-started/overview/iapps.md rename to src/get-started/overview/iapp.md index e20fe96c..fd99fd97 100644 --- a/src/get-started/overview/iapps.md +++ b/src/get-started/overview/iapp.md @@ -6,7 +6,7 @@ description: AI, data analysis, and Web3 apps. --- -# iApps +# iApp An iExec Application (iApp) brings Turnkey Privacy to your regular application code. Your Python scripts, AI models, or data processors can securely process diff --git a/src/get-started/overview/what-is-iexec.md b/src/get-started/overview/what-is-iexec.md index bee729c9..e1b054cb 100644 --- a/src/get-started/overview/what-is-iexec.md +++ b/src/get-started/overview/what-is-iexec.md @@ -17,7 +17,7 @@ developers build privacy-preserving applications. Your sensitive data gets encrypted and stored online. Only you control who can access it. -→ **Devtool**: [DataProtector](/references/dataProtector) handles this for you +→ **DevTool**: [DataProtector](/references/dataProtector) handles this for you ### Step 2: Secure Computing (Workers) @@ -25,13 +25,13 @@ Code runs inside **secure enclaves** (TEEs) on iExec workers. The worker can access your data to process it, but only within the privacy-safe TEE environment - your data never leaves the secure bubble. -### Step 3: Run iApps +### Step 3: Run iApp You submit a **Task** = "Run this iApp on this protected data". The protocol finds available workers and executes everything confidentially. -→ **Devtool**: [iApp Generator](/references/iapp-generator) helps you create and -deploy iApps +→ **DevTool**: [iApp Generator](/references/iapp-generator) helps you create and +deploy iApp ### Step 4: Get Results @@ -49,7 +49,7 @@ Protected Data + iApp + Worker = Task → Encrypted Result Your data, encrypted. You set the rules: "Only these apps can use it, only for these purposes." -### **iApps** +### **iApp** Your code, packaged to run on workers. Can be AI models, data processing scripts, any computation. @@ -90,7 +90,7 @@ Now that you get the protocol, pick your devtools: under the hood) - **Protect Data**: Try [DataProtector](/references/dataProtector) to encrypt your first dataset -- **Build iApps**: Create confidential compute with +- **Build iApp**: Create confidential compute with [iApp Generator](/references/iapp-generator) - **Hands-On**: Follow our [Hello World](/get-started/helloWorld) to see all devtools working together diff --git a/src/get-started/overview/workerpools.md b/src/get-started/overview/workerpool.md similarity index 90% rename from src/get-started/overview/workerpools.md rename to src/get-started/overview/workerpool.md index e3431ac9..e87247bd 100644 --- a/src/get-started/overview/workerpools.md +++ b/src/get-started/overview/workerpool.md @@ -1,17 +1,17 @@ --- title: Workerpools description: - Learn about workerpools in iExec - the computing resources that execute iApps + Learn about workerpools in iExec - the computing resources that execute iApp --- # Workerpools A **Workerpool** is a group of computing machines (workers) managed by a -**Workerpool Manager** that provides computational resources to execute iApps in +**Workerpool Manager** that provides computational resources to execute iApp in secure environments on the iExec network.
          -

          Think of workerpools as computing clusters where your iApps run. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.

          +

          Think of workerpools as computing clusters where your iApp run. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.

          ## Key Concepts @@ -58,7 +58,7 @@ secure environments on the iExec network.
          •
          - Task Execution: Run iApps and process protected data securely + Task Execution: Run iApp and process protected data securely
          @@ -137,7 +137,7 @@ secure environments on the iExec network. ## Getting Started
          -

          Want to use workerpools? Start building iApps and the protocol will handle workerpool selection automatically. Want to operate a workerpool? Check our deployment guides.

          +

          Want to use workerpools? Start building iApp and the protocol will handle workerpool selection automatically. Want to operate a workerpool? Check our deployment guides.

          ## Next Steps diff --git a/src/references/iapp-generator.md b/src/references/iapp-generator.md index 7b77475d..c653c8b3 100644 --- a/src/references/iapp-generator.md +++ b/src/references/iapp-generator.md @@ -37,7 +37,7 @@ SGX/TDX secure enclaves where data stays private during processing. Start here to understand what iApp are and how they work: -- **[iApps](/get-started/overview/iapps)** - Core concepts and TEE overview +- **[iApp](/get-started/overview/iapp)** - Core concepts and TEE overview - **[Getting Started](/references/iapp-generator/getting-started)** - Your first iApp in 15 minutes - **[Building Your iApp](/references/iapp-generator/building-your-iexec-app)** - From 0b97a1241383644bcd80d2a7e40a799c839fc5dd Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Mon, 18 Aug 2025 17:02:00 +0200 Subject: [PATCH 4/5] Update Workerpool terminology for consistency in sidebar and documentation Renamed instances of "Workerpools" to "Workerpool" in the sidebar and related documentation to ensure uniformity. Adjusted text and links accordingly for clarity. --- .vitepress/sidebar.ts | 4 ++-- src/get-started/overview/workerpool.md | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 173f9fa8..af4a6d47 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -68,8 +68,8 @@ export function getSidebar() { link: '/get-started/overview/iapp', }, { - text: 'Workerpools', - link: '/get-started/overview/workerpools', + text: 'Workerpool', + link: '/get-started/overview/workerpool', }, { text: '🪙 RLC Token', diff --git a/src/get-started/overview/workerpool.md b/src/get-started/overview/workerpool.md index e87247bd..26699824 100644 --- a/src/get-started/overview/workerpool.md +++ b/src/get-started/overview/workerpool.md @@ -1,17 +1,17 @@ --- -title: Workerpools +title: Workerpool description: - Learn about workerpools in iExec - the computing resources that execute iApp + Learn about workerpool in iExec - the computing resources that execute iApp --- -# Workerpools +# Workerpool A **Workerpool** is a group of computing machines (workers) managed by a **Workerpool Manager** that provides computational resources to execute iApp in secure environments on the iExec network.
          -

          Think of workerpools as computing clusters where your iApp run. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.

          +

          Think of a workerpool as a computing cluster where your iApp runs. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.

          ## Key Concepts @@ -97,7 +97,7 @@ secure environments on the iExec network.
          -## How Workerpools Work +## How Workerpool Work
          @@ -137,7 +137,7 @@ secure environments on the iExec network. ## Getting Started
          -

          Want to use workerpools? Start building iApp and the protocol will handle workerpool selection automatically. Want to operate a workerpool? Check our deployment guides.

          +

          Want to use workerpool? Start building iApp and the protocol will handle workerpool selection automatically.

          ## Next Steps @@ -146,7 +146,7 @@ secure environments on the iExec network.
          - Start Using: Build your first iApp and see workerpools in action + Start Using: Build your first iApp and see a workerpool in action
          From 215142f4ff432825d544b544468cabe4058052fa Mon Sep 17 00:00:00 2001 From: Mathis Debuire <68806646+64ix@users.noreply.github.com> Date: Mon, 18 Aug 2025 17:50:48 +0200 Subject: [PATCH 5/5] Clarify description of Deals in iExec overview Updated the explanation of 'Deals' to better describe the execution flow, specifying the use of TEE Workers and encrypted result handling for improved clarity. --- src/get-started/overview/what-is-iexec.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/get-started/overview/what-is-iexec.md b/src/get-started/overview/what-is-iexec.md index e1b054cb..bd416f56 100644 --- a/src/get-started/overview/what-is-iexec.md +++ b/src/get-started/overview/what-is-iexec.md @@ -62,8 +62,9 @@ tamper-proof. ### **Deals** -A job request: "Execute iApp X on protected data Y, send results to Z." The -protocol handles the rest. +The execution instruction that unifies the entire flow: "Run this iApp on this +Protected Data using a TEE Worker, then return the encrypted result to me." The +protocol takes care of worker allocation and secure coordination. ## Real Example Walkthrough