Skip to content

Commit 2770a77

Browse files
committed
Merge branch 'main' into feature/update-style-and-components
2 parents e5956c4 + 5db3d2c commit 2770a77

Some content is hidden

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

64 files changed

+1595
-1667
lines changed

.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ export default withMermaid(
103103
{ text: 'Get Started', link: '/get-started/welcome' },
104104
{ text: 'Guides', link: '/guides/build-iapp/build-&-test' },
105105
{ text: 'References', link: '/references/dataProtector' },
106+
{ text: 'Protocol', link: '/protocol/proof-of-contribution' },
106107
{
107108
component: 'ChainSelector',
108109
props: {

.vitepress/sidebar.ts

Lines changed: 69 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -102,59 +102,6 @@ export function getSidebar() {
102102
},
103103
],
104104
},
105-
{
106-
text: 'PROTOCOL',
107-
items: [
108-
{
109-
text: '🛡️ Proof of Contribution',
110-
link: '/get-started/protocol/proof-of-contribution',
111-
},
112-
{
113-
text: 'Pay Per Task Model',
114-
link: '/get-started/protocol/pay-per-task',
115-
},
116-
{
117-
text: 'Oracle',
118-
link: '/get-started/protocol/oracle',
119-
},
120-
{
121-
text: 'Workers & Workerpools',
122-
collapsed: true,
123-
items: [
124-
{
125-
text: 'Worker Quick Start',
126-
link: '/get-started/protocol/worker/quick-start',
127-
},
128-
{
129-
text: 'Manage Workerpool Access',
130-
link: '/get-started/protocol/worker/manage-access',
131-
},
132-
],
133-
},
134-
{
135-
text: '🔒 TEE Technology',
136-
collapsed: true,
137-
items: [
138-
{
139-
text: 'Introduction to TEE Technologies',
140-
link: '/get-started/protocol/tee/introduction',
141-
},
142-
{
143-
text: 'Intel SGX Technology',
144-
link: '/get-started/protocol/tee/intel-sgx',
145-
},
146-
{
147-
text: 'Intel TDX Technology',
148-
link: '/get-started/protocol/tee/intel-tdx',
149-
},
150-
{
151-
text: 'SGX vs TDX Comparison',
152-
link: '/get-started/protocol/tee/sgx-vs-tdx',
153-
},
154-
],
155-
},
156-
],
157-
},
158105
],
159106
'/guides/': [
160107
{
@@ -190,8 +137,12 @@ export function getSidebar() {
190137
link: '/guides/build-iapp/manage-access',
191138
},
192139
{
193-
text: 'Inputs and Outputs',
194-
link: '/guides/build-iapp/inputs-and-outputs',
140+
text: 'Inputs',
141+
link: '/guides/build-iapp/inputs',
142+
},
143+
{
144+
text: 'Outputs',
145+
link: '/guides/build-iapp/outputs',
195146
},
196147

197148
{
@@ -203,28 +154,24 @@ export function getSidebar() {
203154
collapsed: true,
204155
items: [
205156
{
206-
text: 'Quick Start for Developers',
207-
link: '/guides/build-iapp/advanced/quick-start-for-developers',
208-
},
209-
{
210-
text: 'Build your first application',
211-
link: '/guides/build-iapp/advanced/your-first-app',
157+
text: 'Quick Start',
158+
link: '/guides/build-iapp/advanced/quick-start',
212159
},
213160
{
214161
text: 'Build your first SGX app',
215-
link: '/guides/build-iapp/advanced/create-your-first-sgx-app',
162+
link: '/guides/build-iapp/advanced/build-your-first-sgx-iapp',
216163
},
217164
{
218165
text: 'End-to-end Encryption',
219-
link: '/guides/build-iapp/advanced/end-to-end-encryption',
166+
link: '/guides/build-iapp/advanced/protect-the-result',
220167
},
221168
{
222169
text: 'Access Confidential Assets',
223170
link: '/guides/build-iapp/advanced/access-confidential-assets',
224171
},
225172
{
226173
text: 'Build Intel TDX app',
227-
link: '/guides/build-iapp/advanced/create-your-first-tdx-app',
174+
link: '/guides/build-iapp/advanced/build-your-first-tdx-iapp',
228175
},
229176
],
230177
},
@@ -255,7 +202,7 @@ export function getSidebar() {
255202
},
256203
{
257204
text: 'Integrate Web3 Messaging',
258-
link: '/guides/use-iapp/web3-messaging',
205+
link: '/guides/use-iapp/integrate-web3-messaging',
259206
},
260207
],
261208
},
@@ -586,5 +533,62 @@ export function getSidebar() {
586533
link: '/references/glossary',
587534
},
588535
],
536+
'/protocol/': [
537+
{
538+
text: 'PROTOCOL',
539+
items: [
540+
{
541+
text: '🛡️ Proof of Contribution',
542+
link: '/protocol/proof-of-contribution',
543+
},
544+
{
545+
text: 'Pay Per Task Model',
546+
link: '/protocol/pay-per-task',
547+
},
548+
{
549+
text: 'Oracle',
550+
link: '/protocol/oracle',
551+
},
552+
{
553+
text: 'Workers & Workerpools',
554+
items: [
555+
{
556+
text: 'Worker Quick Start',
557+
link: '/protocol/worker/quick-start',
558+
},
559+
{
560+
text: 'Manage Workerpool Access',
561+
link: '/protocol/worker/manage-access',
562+
},
563+
],
564+
},
565+
{
566+
text: '🔒 TEE Technology',
567+
items: [
568+
{
569+
text: 'Introduction to TEE Technologies',
570+
link: '/protocol/tee/introduction',
571+
},
572+
{
573+
text: 'Intel SGX Technology',
574+
link: '/protocol/tee/intel-sgx',
575+
},
576+
{
577+
text: 'Intel TDX Technology',
578+
link: '/protocol/tee/intel-tdx',
579+
},
580+
{
581+
text: 'SGX vs TDX Comparison',
582+
link: '/protocol/tee/sgx-vs-tdx',
583+
},
584+
],
585+
},
586+
{
587+
text: '🤖 AI Framework Support',
588+
link: '/protocol/ai',
589+
},
590+
],
591+
},
592+
],
589593
} as DefaultTheme.Sidebar;
590594
}

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -226,38 +226,29 @@ for input parameters:
226226

227227
## TODO
228228

229-
- Adapt hardcoded address to feat with new contracts deployed on arbitrum
230229
- Add link to the new explorer feature Asset_Types in the guide =>
231230
`handle-schemas-dataset-types`
232231
- Add link to remix for deploying whitelist
233-
- complete `use-iapp` section
234-
- Maybe split input and output in two diff sub section in build your iapp guide
235232
- Explorer l'intégration de codeSpace
236233
- Add a Development workflow section (1 - ProtectData, 2- ...)
237234
- Update context7 when doc will be deployed (Martin)
238235
- Check theGraph Images with design Team
239236
- Update the Dune Dashboard to the final version
240237
- Add new section in `iexec-explorer.md` file to talk about: available chain on
241238
the UI + SRLC/RLC on account section feature of the protocol
242-
- Update or add design illustrations based on the new design system
243-
- Check how to pay guide to update with the launch on Arbitrum (RLC vs xRLC)
244-
- framework AI supporté
245239
- check glossary
246-
- migrate github iexec SDK doc here
247240
- migrate pay-per-task page into a guide
248241
- check pages (introduction & getting-started) for use-iapp guide
249242
- Schema what is iexec to do and implement
250243
- Give recap of Workerpool address fo chains
251244
- Talk about ENS on Bellecour(it's not supported on arbitrum)
252-
- Rework Advanced iApp building guides. (from "old" protocol doc) <<<<<<< HEAD
253245
- Talk about encrypting results in use-iapp
254246
- Refactor "advanced" section in build-iapp
255247
- Rework src\get-started\protocol\iexec-doracle.md (transfer to guide or
256248
rewrite)
257-
- Talk about encrypting results in use-iapp
258-
- Refactor "advanced" section in build-iapp
249+
- Talk about encrypting results in use-iapp (link in outputs, iapp generator...)
259250
- Rework src\get-started\protocol\oracle.md (transfer to guide or rewrite)
260251
- Talk about iApp secret
261252
- Improve Guide in build-iapp section - be more clear for builder ( how to
262253
process process protectedData, clarify input-output guide)
263-
- refactor iapp generator cli reference
254+
- Add illustration in the different pages

src/assets/use-cases/elizaos.png

415 KB
Loading
2.56 MB
Loading
1.48 MB
Loading
1.66 MB
Loading

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ import CardWithoutBorder from '../../components/CardWithoutBorder.vue'
1818
1919
<Banner>
2020

21-
## Let's start with the basics
21+
## Start with the basics
2222

23-
and explore how iExec can help you build Privacy-preserving applications and
23+
and explore how iExec can help you build Privacy-preserving apps and
2424
securely manage sensitive data.
2525

2626
</Banner>
2727

2828
## 👨‍💻 Building Privacy-preserving iApp with iExec
2929

30-
Imagine you're building a decentralized application (iApp) that needs to
30+
Imagine you're building a decentralized app (dApp) that needs to
3131
**handle sensitive user data**, for example:
3232

3333
<CardWithoutBorder class="**:list-none *:pl-0!">
@@ -48,7 +48,7 @@ Imagine you're building a decentralized application (iApp) that needs to
4848

4949
::: tip <i></i>
5050

51-
This is where **iExec** comes in! We provide tools to easily add **privacy** and
51+
This is where **iExec** comes in! iExec provides tools to easily add **privacy** and
5252
**monetization** features into your iApp.
5353

5454
:::
@@ -58,14 +58,14 @@ This is where **iExec** comes in! We provide tools to easily add **privacy** and
5858
Unlike traditional tools, iExec protects your data throughout its entire
5959
lifecycle - during storage, transfer, and even while **being processed by
6060
applications.** This is made possible thanks to
61-
**<a target="_blank" href="https://protocol.docs.iex.ec/for-developers/confidential-computing/intel-sgx-technology">Trusted
61+
**<a target="_blank" href="/protocol/tee/introduction">Trusted
6262
Execution Environment (TEE)</a>** and
6363
**<a target="_blank" href="https://www.iex.ec/academy/iexec-decentralized-confidential-computing">Confidential
6464
Computing</a>** technologies.
6565

6666
::: tip <i></i>
6767

68-
Our technology allows users to control the **ownership**, **confidentiality**,
68+
The technology allows users to control the **ownership**, **confidentiality**,
6969
and **monetization** of their data and digital assets within the **Web3**
7070
ecosystem.
7171

@@ -96,7 +96,7 @@ iExec combines three fundamental elements that work together seamlessly:
9696

9797
::: tip <i></i>
9898

99-
By merging **blockchain technology** with **confidential computing**, we've
99+
By merging **blockchain technology** with **confidential computing**, iExec
100100
pioneered
101101
**<a target="_blank" href="https://www.iex.ec/academy/iexec-decentralized-confidential-computing">DeCC</a>**
102102
(Decentralized Confidential Computing) to take **privacy** and **security** to
@@ -171,7 +171,7 @@ And many other use cases...
171171
</div>
172172
<div class="flex items-center gap-3">
173173
<span class="text-xl">🔌</span>
174-
<p class="m-0"><strong>Wide Application:</strong> From AI to finance, enabling confidential data processing across various industries</p>
174+
<p class="m-0"><strong>Wide application:</strong> From AI to finance, enabling confidential data processing across various industries</p>
175175
</div>
176176
</div>
177177

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Let's Protect Data
2+
title: Protect Data
33
description:
44
Learn how to protect your data using iExec's DataProtector SDK in this
55
hands-on tutorial step.
@@ -11,22 +11,22 @@ import Banner from '../../components/Banner.vue'
1111
import Container from '../../components/Container.vue'
1212
</script>
1313

14-
# 🛡️ Let's Protect Data
14+
# 🛡️ Protect Data
1515

1616
> Reading time: 6 minutes
1717
1818
<Banner>
1919

2020
## Time to get practical
2121

22-
Let's follow Alice as she learns how to protect her data using DataProtector on
23-
Bob's iApp, our developer tool for protecting data creation and management.
22+
Follow Alice as she learns how to protect her data using DataProtector on
23+
Bob's dApp, the developer tool for protecting data creation and management.
2424

2525
</Banner>
2626

2727
::: tip <i></i>
2828

29-
**Protected data** is encrypted data that remains confidential throughout its
29+
**Protected data** refers to encrypted data that remains confidential throughout its
3030
entire lifecycle - during storage, transfer and processing.
3131

3232
:::
@@ -53,7 +53,7 @@ their DApp with these key features:
5353
Features an SDK for easy integration into your DApp, enhancing functionality
5454
and user experience.
5555

56-
## 🧩 Let's Create Protected Data
56+
## 🧩 Create protected data
5757

5858
<ProtectData />
5959

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

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

95-
![alt](/assets/hello-world/dataprotector_light.png){.light-only}
96-
![alt](/assets/hello-world/dataprotector_dark.png){.dark-only}
95+
![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}
96+
![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}
9797

9898
<div class="flex flex-col gap-2.5 my-6">
9999
<div class="flex items-center gap-3">
@@ -102,7 +102,7 @@ button:
102102
</div>
103103
<div class="flex items-center gap-3">
104104
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">2</span>
105-
<span>The data is encrypted with a symmetric key</span>
105+
<span>DataProtector encrypts the data with a symmetric key</span>
106106
</div>
107107
<div class="flex items-center gap-3">
108108
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">3</span>
@@ -118,7 +118,7 @@ button:
118118
</div>
119119
<div class="flex items-center gap-3">
120120
<span class="bg-gray-950 text-sm text-white w-6 h-6 rounded-full flex items-center justify-center font-medium">6</span>
121-
<span>The protected data address is returned to the user</span>
121+
<span>The system returns the protected data address to the user</span>
122122
</div>
123123
</div>
124124

@@ -192,7 +192,9 @@ sandbox</a> for ready-to-use examples!
192192

193193
- 🔒 **DataProtector** ensures data protection, management, and confidentiality
194194

195-
- 📦 **Protected Data** is encrypted and stored on decentralized storage
195+
- 📦 **Protected Data** - DataProtector encrypts and stores data on
196+
decentralized storage such as [ar.io](https://ar.io) or
197+
[IPFS](https://ipfs.io)
196198

197199
- ⛓️ **Ownership** iExec's protocol writes ownership on the blockchain and links
198200
it to your wallet
@@ -201,7 +203,7 @@ sandbox</a> for ready-to-use examples!
201203

202204
<Container variant="success">
203205

204-
In the next chapter, we'll show you how to build, deploy, and run an iApp to
205-
process your protected data. Let's go! 🚀
206+
In the next chapter, learn how to build, deploy, and run an iApp to
207+
process your protected data.
206208

207209
</Container>

0 commit comments

Comments
 (0)