Skip to content

Commit 19bd3f2

Browse files
chainsonaLe-Caignecaimen-djari
committed
Copywriting - Content Review V2 (#51)
Co-authored-by: Robin Le Caignec <72495599+Le-Caignec@users.noreply.github.com> Co-authored-by: aimen-djari <aimen.djari@iex.ec>
1 parent 8760a0d commit 19bd3f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+993
-260
lines changed

CHECKLIST.md

Lines changed: 441 additions & 0 deletions
Large diffs are not rendered by default.

src/get-started/helloWorld/1-overview.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ description:
1111
> Reading time 🕒 8 min
1212
1313
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
14-
<h2 class="text-2xl font-bold mt-0 border-none!">Let's start with the basics</h2>
15-
<p>and explore how iExec can help you build Privacy-preserving applications and securely manage sensitive data.</p>
14+
<h2 class="text-2xl font-bold mt-0 border-none!">Start with the basics</h2>
15+
<p>and explore how iExec can help you build Privacy-preserving apps and securely manage sensitive data.</p>
1616
</div>
1717

1818
## 👨‍💻 Building Privacy-preserving iApp with iExec
1919

20-
<p>Imagine you're building a decentralized application (iApp) that needs to <strong> handle sensitive user data</strong>, for example:</p>
20+
<p>Imagine you're building a decentralized app (iApp) that needs to <strong> handle sensitive user data</strong>, for example:</p>
2121
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
2222
<div class="flex flex-col gap-2.5">
2323
<div class="flex items-center gap-2 text-base">
@@ -60,7 +60,7 @@ description:
6060
</div>
6161

6262
<div class="bg-gradient-to-r from-purple-400/10 to-purple-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
63-
<p class="m-0!">This is where <span class="text-fuchsia-700 font-semibold">iExec</span> comes in! We provide tools to easily add <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">monetization</span> features into your iApp.</p>
63+
<p class="m-0!">This is where <span class="text-fuchsia-700 font-semibold">iExec</span> comes in. iExec provides tools to easily add <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">monetization</span> features into your iApp.</p>
6464
</div>
6565

6666
## 👷 How do we Solve it?
@@ -76,7 +76,7 @@ Execution Environment (TEE)</a></span> and
7676
Computing</a></span> technologies.
7777

7878
<div class="bg-gradient-to-r from-purple-400/10 to-purple-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
79-
<p class="m-0!">Our technology allows users to control the <span class="text-fuchsia-700 font-semibold">ownership</span>,
79+
<p class="m-0!">The technology allows users to control the <span class="text-fuchsia-700 font-semibold">ownership</span>,
8080
<span class="text-fuchsia-700 font-semibold">confidentiality</span>, and <span class="text-fuchsia-700 font-semibold">monetization</span> of their data and digital assets within the <span class="text-fuchsia-700 font-semibold">Web3</span> ecosystem.</p>
8181
</div>
8282

@@ -104,7 +104,7 @@ iExec combines three fundamental elements that work together seamlessly:
104104
- Provides transparent governance rules for data access
105105

106106
<div class="bg-gradient-to-r from-purple-400/10 to-purple-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
107-
<p class="m-0!">By merging <span class="text-fuchsia-700 font-semibold">blockchain technology</span> with <span class="text-fuchsia-700 font-semibold">confidential computing</span>, we've pioneered <span class="text-fuchsia-700 font-semibold"><a target="_blank" href="https://www.iex.ec/academy/iexec-decentralized-confidential-computing">DeCC</a></span> (Decentralized Confidential Computing) to take <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">security</span> to the next level in <span class="text-fuchsia-700 font-semibold">Web3</span> ecosystems.</p>
107+
<p class="m-0!">By merging <span class="text-fuchsia-700 font-semibold">blockchain technology</span> with <span class="text-fuchsia-700 font-semibold">confidential computing</span>, iExec pioneered <span class="text-fuchsia-700 font-semibold"><a target="_blank" href="https://www.iex.ec/academy/iexec-decentralized-confidential-computing">DeCC</a></span> (Decentralized Confidential Computing) to take <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">security</span> to the next level in <span class="text-fuchsia-700 font-semibold">Web3</span> ecosystems.</p>
108108
</div>
109109

110110
### 🧸 DeCC Explained Like You're 5
@@ -174,10 +174,10 @@ And many other use cases...
174174
</div>
175175
<div class="flex items-center gap-3">
176176
<span class="text-xl">🔌</span>
177-
<p class="m-0"><strong>Wide Application:</strong> From AI to finance, enabling confidential data processing across various industries</p>
177+
<p class="m-0"><strong>Wide application:</strong> From AI to finance, enabling confidential data processing across various industries</p>
178178
</div>
179179
</div>
180180

181181
<div class="bg-gradient-to-r from-green-400/10 to-green-400/5 rounded-[6px] p-6 border-l-4 border-green-600 mb-6">
182-
<p class="m-0!">Now that you understand the fundamentals, let's dive into protecting your first piece of data! With Alice!</p>
182+
<p class="m-0!">Now that you understand the fundamentals, dive into protecting your first piece of data with Alice.</p>
183183
</div>

src/get-started/helloWorld/2-protectData.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
2-
title: Let's Protect Data
2+
title: Protect Data
33
description:
4-
Learn how to protect your data using iExec's DataProtector SDK in this
5-
hands-on tutorial step.
4+
Learn how to protect your data using iExec's DataProtector Software
5+
Development Kit (SDK) in this hands-on tutorial step.
66
---
77

88
<script setup>
99
import ProtectData from '@/modules/helloWorld/ProtectData.vue';
1010
</script>
1111

12-
# 🛡️ Let's Protect Data
12+
# 🛡️ Protect Data
1313

1414
> Reading time: 6 minutes
1515
1616
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
1717
<h2 class="text-2xl font-bold mt-0 border-none!">Time to get practical</h2>
18-
<p>Let's follow Alice as she learns how to protect her data using DataProtector on Bob's iApp, our developer tool for protecting data creation and management.</p>
18+
<p>Follow Alice as she learns how to protect her data using DataProtector on Bob's iApp, the developer tool for protecting data creation and management.</p>
1919
</div>
2020

2121
<div class="bg-gradient-to-r from-fuchsia-400/10 to-fuchsia-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
22-
<p class="m-0!"><strong>Protected data</strong> is encrypted data that remains confidential throughout its entire lifecycle - during storage, transfer and processing.</p>
22+
<p class="m-0!"><strong>Protected data</strong> refers to encrypted data that remains confidential throughout its entire lifecycle - during storage, transfer and processing.</p>
2323
</div>
2424

2525
## 🧩 DataProtector, Key Features
@@ -45,7 +45,7 @@ their DApp with these key features:
4545
Features an SDK for easy integration into your DApp, enhancing functionality
4646
and user experience.
4747

48-
## 🧩 Let's Create Protected Data
48+
## 🧩 Create protected data
4949

5050
<ProtectData />
5151

@@ -77,12 +77,12 @@ const { address: protectedDataAddress } = await dataProtectorCore.protectData({
7777

7878
For this tutorial, you can try out the code directly in our interactive
7979
CodeSandbox demo
80-
[here](https://codesandbox.io/p/github/iExecBlockchainComputing/dataprotector-sandbox/main?file=%2Fsrc%2FApp.tsx&preventWorkspaceRedirect=true).
80+
[try the interactive DataProtector sandbox](https://codesandbox.io/p/github/iExecBlockchainComputing/dataprotector-sandbox/main?file=%2Fsrc%2FApp.tsx&preventWorkspaceRedirect=true).
8181
Here's a quick overview of what happened when you clicked the **Protect Data**
8282
button:
8383

84-
![alt](/assets/hello-world/dataprotector_light.png){.light-only}
85-
![alt](/assets/hello-world/dataprotector_dark.png){.dark-only}
84+
![DataProtector workflow diagram showing the 4-step process: SDK called, data encrypted with symmetric key, protected data address returned to user, and protected data encrypted and stored on decentralized storage](/assets/hello-world/dataprotector_light.png){.light-only}
85+
![DataProtector workflow diagram showing the 4-step process: SDK called, data encrypted with symmetric key, protected data address returned to user, and protected data encrypted and stored on decentralized storage](/assets/hello-world/dataprotector_dark.png){.dark-only}
8686

8787
<div class="flex flex-col gap-2.5 my-6">
8888
<div class="flex items-center gap-3">
@@ -91,7 +91,7 @@ button:
9191
</div>
9292
<div class="flex items-center gap-3">
9393
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">2</span>
94-
<span>The data is encrypted with a symmetric key</span>
94+
<span>DataProtector encrypts the data with a symmetric key</span>
9595
</div>
9696
<div class="flex items-center gap-3">
9797
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">3</span>
@@ -107,7 +107,7 @@ button:
107107
</div>
108108
<div class="flex items-center gap-3">
109109
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">6</span>
110-
<span>The protected data address is returned to the user</span>
110+
<span>The system returns the protected data address to the user</span>
111111
</div>
112112
</div>
113113

@@ -177,13 +177,14 @@ const { address: protectedDataAddress } = await dataProtectorCore.protectData({
177177

178178
- 🔒 **DataProtector** ensures data protection, management, and confidentiality
179179

180-
- 📦 **Protected Data** is encrypted and stored on decentralized storage
180+
- 📦 **Protected Data** - DataProtector encrypts and stores data on
181+
decentralized storage
181182

182183
- ⛓️ **Ownership** iExec's protocol writes ownership on the blockchain and links
183184
it to your wallet
184185

185186
- 🔌 **Integration** is simple with our developer tools
186187

187188
<div class="bg-gradient-to-r from-green-400/10 to-green-400/5 rounded-[6px] p-6 border-l-4 border-green-600 mb-6">
188-
<p class="m-0!">In the next chapter, we'll show you how to build, deploy, and run an iApp to process your protected data. Let's go! 🚀</p>
189+
<p class="m-0!">In the next chapter, learn how to build, deploy, and run an iApp to process your protected data.</p>
189190
</div>

src/get-started/helloWorld/3-buildIApp.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ description:
55
processing protected data in this comprehensive tutorial.
66
---
77

8-
# 🛠️ Build and Deploy your First iApp
8+
# 🛠️ Build and deploy your first iApp
99

1010
> Reading time 🕒 10 min
1111
1212
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
13-
<h2 class="text-2xl font-bold mt-0 border-none!">Time to build!</h2>
14-
<p>Let's build an iApp that can process protected data in a secure environment using the <a href="/references/iapp-generator" target="_blank" class="!text-gray-900 !font-bold underline hover:!text-black">iExec iApp generator tool</a>. This tool helps you create, test and deploy iApp with just a few commands.</p>
13+
<h2 class="text-2xl font-bold mt-0 border-none!">Time to build</h2>
14+
<p>Build an iApp that can process protected data in a secure environment using the <a href="/references/iapp-generator" target="_blank" class="!text-gray-900 !font-bold underline hover:!text-black">iExec iApp generator tool</a>. This tool helps you create, test, and deploy iApp with just a few commands.</p>
1515
</div>
1616

17-
If you wanna explore and deep dive in the CLI. You can check the
18-
[iApp-CLI](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli)
19-
github repository. Follow the instructions carefully for a smooth development
17+
If you wanna explore and deep dive in the command-line tool. You can check the
18+
[iApp-CLI (Command Line Interface)](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli)
19+
GitHub repository. Follow the instructions carefully for a smooth development
2020
experience.
2121

2222
## 📋 Prerequisites
@@ -46,29 +46,29 @@ Before getting started, make sure you have:
4646
</div>
4747

4848
<div class="bg-gradient-to-r from-fuchsia-400/10 to-fuchsia-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
49-
<p class="m-0!">Don't worry! All secrets used in this tutorial stay on your machine and arent shared with anyone. Youll only need them to run the <code>iapp run</code> command.</p>
49+
<p class="m-0!">Don't worry. All secrets used in this tutorial stay on your machine and aren't shared with anyone. You'll only need them to run the <code>iapp run</code> command.</p>
5050
</div>
5151

52-
## 🚀 Types of iApp you Can Build
52+
## 🚀 Types of iApp you can build
5353

5454
iExec enables you to build various types of Privacy-preserving applications.
5555
Here are some popular use cases:
5656

57-
### 📧 Web3 Mail
57+
### 📧 Web3 mail
5858

5959
Send privacy-preserving emails to registered Ethereum account holders without
6060
knowing or storing their email addresses.
6161
[Github](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/dapp)
6262
| [Documentation](/references/web3mail)
6363

64-
### 💬 Web3 Telegram
64+
### 💬 Web3 telegram
6565

6666
Send privacy-preserving Telegram messages without knowing or storing their
6767
Telegram handles.
6868
[Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp)
6969
| [Documentation](/references/web3telegram)
7070

71-
### 🌐 Content Delivery
71+
### 🌐 Content delivery
7272

7373
Transfer, sell or rent protected content to authorized users.
7474
[Github](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/protected-data-delivery-dapp)
@@ -171,7 +171,7 @@ You will be prompted with the following message:
171171
'🐳 Added Dockerfile',
172172
'⚙️ Added iExec configuration'
173173
]"
174-
:successMessage="'Your iApp is ready!'"
174+
:successMessage="'Your iApp is ready'"
175175
/>
176176

177177
<div class="flex flex-col gap-2.5 my-6">
@@ -196,7 +196,7 @@ You will be prompted with the following message:
196196
</div>
197197

198198
<div class="bg-gradient-to-r from-fuchsia-400/10 to-fuchsia-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
199-
<p class="m-0!">We recommend selecting <span class="text-fuchsia-700 font-semibold">"Hello World"</span> to quickly discover how iApp works! use <span class="text-fuchsia-700 font-semibold">advanced</span> only if you are familiar with iExec.</p>
199+
<p class="m-0!">We recommend selecting <span class="text-fuchsia-700 font-semibold">"Hello World"</span> to quickly discover how iApp works. Use <span class="text-fuchsia-700 font-semibold">advanced</span> only if you are familiar with iExec.</p>
200200
</div>
201201

202202
- An iApp project is setup with the selected language
@@ -288,7 +288,7 @@ simulating how it will run in the iExec network's TEE environment.
288288
<p class="m-0!">- If you get <code>Error: Failed to locate iApp project root</code>: Ensure you are in your project folder before proceeding.</p>
289289
</div>
290290

291-
### 🧩 Using Arguments
291+
### 🧩 Using arguments
292292

293293
You can pass arguments to your iApp using the `--args` option. This allows you
294294
to provide necessary inputs during runtime (you can use your name for example).
@@ -297,7 +297,7 @@ to provide necessary inputs during runtime (you can use your name for example).
297297
iapp test --args your-name
298298
```
299299

300-
### 🔒 Using Protected Data
300+
### 🔒 Using protected data
301301

302302
You can pass a protectedData that you are authorized to process to your iApp
303303
using the `--protectedData` option.
@@ -370,7 +370,7 @@ Once you have your token, you can deploy your iApp.
370370
</template>
371371

372372
<div class="bg-gradient-to-r from-fuchsia-400/10 to-fuchsia-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6">
373-
<p class="m-0!">📝 Make sure to save your <span class="text-fuchsia-700 font-semibold">iApp address</span> after deployment - you'll need it later!</p>
373+
<p class="m-0!">📝 Make sure to save your <span class="text-fuchsia-700 font-semibold">iApp address</span> after deployment - you'll need it later.</p>
374374
<p class="m-0!">You can find your iApp address in the <code>iexec-app.json</code> file in your project folder.</p>
375375
<br>
376376
<p class="m-0!">⚠️ If you encounter issues during deployment, make sure the Docker BuildKit feature is enabled and supports AMD64 architecture:</p>
@@ -401,7 +401,7 @@ allowing it to run securely in a **Trusted Execution Environment (TEE)** for
401401
<p class="m-0!">🎉 Congratulations! You've successfully deployed and run your first iApp on iExec. This is a significant milestone - your application is now ready to securely process confidential data in a trusted environment.</p>
402402
</div>
403403

404-
## 🎯 Key Takeaways
404+
## 🎯 Key takeaways
405405

406406
- 🔒 **iApp:** Special applications that run in TEEs to process protected data
407407
- 🛠️ **iApp CLI:** Command-line tool for building, testing, and deploying iApp
@@ -410,7 +410,7 @@ allowing it to run securely in a **Trusted Execution Environment (TEE)** for
410410
environments
411411

412412
<div class="bg-gradient-to-r from-green-400/10 to-green-400/5 rounded-[6px] p-6 border-l-4 border-green-600 mb-6">
413-
<p class="m-0!">Next up: Alice will learn how to authorize the iApp and Bob to access and use her protected data! 🚀</p>
413+
<p class="m-0!">Next up: Alice will learn how to authorize the iApp and Bob to access and use her protected data.</p>
414414
</div>
415415

416416
<script setup>

src/get-started/overview/iapp.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ Turnkey Privacy iApp, they will.**
6565
## How it Works
6666

6767
Your code runs in a Trusted Execution Environment (TEE). This secure area exists
68-
inside specific processors (Intel SGX/TDX chipset). Everything stays private and
69-
protected there, even from the operating system.
68+
inside specific processors (Intel Software Guard Extensions (SGX)/Trust Domain
69+
Extensions (TDX) chipset). Everything stays private and protected there, even
70+
from the operating system.
7071

7172
Authorized users trigger iApp that process protected data inside this private
7273
environment. Your iApp uses the data but never exposes it, not even to you.
@@ -148,7 +149,8 @@ the TEE execution environment.
148149
- **Docker**: Your application must be containerized
149150
- **Input/Output**: Define clear input and output schemas
150151
- **TEE Compatibility**: Ensure your code runs in secure enclaves
151-
- **Network Access**: Configure any external API calls or dependencies
152+
- **Network Access**: Configure any external Application Programming Interface
153+
(API) calls or dependencies
152154

153155
## Next Steps
154156

src/get-started/overview/protected-data.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
controls, and secure data monetization.
77
---
88

9-
# Protected Data
9+
# Protected data
1010

1111
Protected Data refers to any data encrypted using the **iExec Data Protector
1212
tool**. This Turnkey Privacy encryption solution enables users to protect,
@@ -16,9 +16,9 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
1616
<p class="m-0!">Unlike standard datasets, Protected Data exposes its <span class="text-fuchsia-700 font-semibold">data types on-chain</span> (indicating types like email addresses or photos). This lets anyone <span class="text-fuchsia-700 font-semibold">identify entries with matching types</span>.</p>
1717
</div>
1818

19-
## Key Concepts
19+
## Key concepts
2020

21-
### Data Governance
21+
### Data governance
2222

2323
<div class="mb-4"></div>
2424

@@ -112,7 +112,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
112112
<div class="flex items-center gap-3">
113113
<span class="text-xl font-bold text-fuchsia-700">2.</span>
114114
<div>
115-
<strong>Share:</strong> Authorize specific users and applications to access your data
115+
<strong>Share:</strong> Authorize specific users and apps to access your data
116116
</div>
117117
</div>
118118
<div class="flex items-center gap-3">
@@ -136,7 +136,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
136136
</div>
137137
</div>
138138

139-
## Use Cases
139+
## Use cases
140140

141141
<div class="grid grid-cols-1 md:grid-cols-2 gap-6 my-6">
142142
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
@@ -188,7 +188,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
188188
<p class="m-0!">Ready to protect your data? Start with our <span class="text-green-700 font-semibold">DataProtector guides</span>. Learn how to secure sensitive information while unlocking its value.</p>
189189
</div>
190190

191-
## Next Steps
191+
## Next steps
192192

193193
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
194194
<div class="flex flex-col gap-4">

0 commit comments

Comments
 (0)