Skip to content

Commit 5aceb59

Browse files
authored
Merge branch 'main' into fix/update-components
2 parents 80c8826 + 2375b8f commit 5aceb59

22 files changed

+223
-93
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export default defineConfig({
8888
{ text: 'Protect Data', link: '/manage-data/what-is-protected-data' },
8989
{ text: 'Build iApp', link: '/build-iapp/what-is-iapp' },
9090
{ text: 'Use iApp', link: '/use-iapp/introduction' },
91-
{ text: 'Core Concept', link: '/core-concept/glossary' },
91+
{ text: 'Protocol', link: '/protocol/sdk' },
9292
],
9393
outline: {
9494
level: [2, 4],

.vitepress/sidebar.ts

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,6 @@ export function getSidebar() {
411411
{ text: '🚀 Getting Started', link: '/use-iapp/getting-started' },
412412
{
413413
text: '📖 Guides',
414-
link: '/use-iapp/guides',
415414
items: [
416415
{
417416
text: 'Different ways to execute an iApp',
@@ -423,11 +422,11 @@ export function getSidebar() {
423422
},
424423
{
425424
text: 'Use iApp with Protected Data',
426-
link: '/use-iapp/use-iapp-with-protected-data',
425+
link: '/use-iapp/guides/use-iapp-with-protected-data',
427426
},
428427
{
429428
text: 'Find iApps to Use',
430-
link: '/use-iapp/find-iapps',
429+
link: '/use-iapp/guides/find-iapps',
431430
},
432431
{
433432
text: 'How to pay the executions',
@@ -437,23 +436,22 @@ export function getSidebar() {
437436
},
438437
{
439438
text: '💰 How to Pay',
440-
link: '/use-iapp/payment',
441439
items: [
442440
{
443441
text: 'How to Pay for Web3mail',
444-
link: '/overview/how-to-pay-for-web3mail',
442+
link: '/use-iapp/how-to-pay/how-to-pay-for-web3mail',
445443
},
446444
{
447445
text: 'How to Pay for Web3telegram',
448-
link: '/use-iapp/web3telegram/how-to-pay-for-web3telegram',
446+
link: '/use-iapp/how-to-pay/how-to-pay-for-web3telegram',
449447
},
450448
{
451449
text: 'Pricing Considerations',
452-
link: '/overview/pricing-considerations',
450+
link: '/use-iapp/how-to-pay/pricing-considerations',
453451
},
454452
{
455-
text: 'Voucher Authorization Guide',
456-
link: '/use-iapp/voucher-guide',
453+
text: 'Voucher',
454+
link: '/use-iapp/how-to-pay/voucher',
457455
},
458456
],
459457
},
@@ -563,21 +561,21 @@ export function getSidebar() {
563561
],
564562
},
565563
],
566-
'/core-concept/': [
564+
'/protocol/': [
567565
{
568-
text: 'CORE CONCEPTS',
566+
text: 'PROTOCOL',
569567
items: [
570568
{
571569
text: '🔧  iExec SDK',
572-
link: '/core-concept/sdk',
570+
link: '/protocol/sdk',
573571
},
574572
{
575573
text: '⚙️  Workers & Workerpools',
576-
link: '/core-concept/workers',
574+
link: '/protocol/workers',
577575
},
578576
{
579577
text: '📖  Glossary',
580-
link: '/core-concept/glossary',
578+
link: '/protocol/glossary',
581579
},
582580
],
583581
},

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ Fork this repository and ensure you're working on the `main` branch:
148148

149149
## TODO
150150

151+
- Add an audit section
151152
- Add Arbitrum support
152153
- On arbitrum hide : Oracle Factory ? , DataProtector Sharing ??
153154
- Adapt hardcoded address to feat with new contracts deployed on arbitrum
@@ -159,4 +160,4 @@ Fork this repository and ensure you're working on the `main` branch:
159160
- complete `use-iapp` section
160161
- complete `explorer` section
161162
- complete `build-iapp` section
162-
- complete `deep-dive`section
163+
- complete `Protocol`section

src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ features:
4343
details:
4444
Create revenue streams from your data while maintaining full control and
4545
privacy
46-
link: /manage-data/guides/monetize-protected-data
46+
link: /use-iapp/how-to-pay/how-to-pay-for-web3mail
4747
- icon: 🧠
48-
title: Core Concepts
48+
title: Protocols
4949
details:
5050
Deep dive into the core concepts of the protocol and understand how iExec
5151
enables privacy, governance, and monetization
52-
link: /core-concept/sdk
52+
link: /protocol/sdk
5353
---

src/overview/helloWorld/1-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Computing</a></span> technologies.
8484

8585
iExec combines three fundamental elements that work together seamlessly:
8686

87-
#### 1. Protect data with our devtool [DataProtector](../../tools/dataProtector/getting-started)
87+
#### 1. Protect data with our devtool [DataProtector](../../manage-data/dataProtector/getting-started)
8888

8989
- Encrypt your sensitive data and store it securely on Arweave or IPFS
9090
- Only you control who can access it and when

src/overview/helloWorld/2-protectData.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,26 @@ simple through our developer tools.
118118
<p><strong>1. Install the Developer Tool</strong></p>
119119
<p>Run the install command:</p>
120120

121-
```sh
121+
::: code-group
122+
123+
```sh [npm]
122124
npm install @iexec/dataprotector
123125
```
124126

127+
```sh [yarn]
128+
yarn add @iexec/dataprotector
129+
```
130+
131+
```sh [pnpm]
132+
pnpm add @iexec/dataprotector
133+
```
134+
135+
```sh [bun]
136+
bun add @iexec/dataprotector
137+
```
138+
139+
:::
140+
125141
</div>
126142
<div>
127143
<p><strong>2. Import and Initialize it in your project</strong></p>

src/overview/helloWorld/3-buildIApp.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import InfoIcon from '../../components/InfoIcon.vue'
88

99
<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">
1010
<h2 class="text-2xl font-bold mt-0 border-none!">Time to build!</h2>
11-
<p>Let's build an iApp that can process protected data in a secure environment using the <a href="../../tools/iapp-generator" target="_blank">iExec iApp generator tool</a>. This tool helps you create, test and deploy iApps with just a few commands.</p>
11+
<p>Let's build an iApp that can process protected data in a secure environment using the <a href="../../build-iapp/iapp-generator" target="_blank">iExec iApp generator tool</a>. This tool helps you create, test and deploy iApps with just a few commands.</p>
1212
</div>
1313

1414
If you wanna explore and deep dive in the CLI. You can check the
@@ -56,33 +56,49 @@ Here are some popular use cases:
5656
Send privacy-preserving emails to registered Ethereum account holders without
5757
knowing or storing their email addresses.
5858
[Github](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/dapp)
59-
| [Documentation](../../tools/web3mail.md)
59+
| [Documentation](../../use-iapp/web3mail)
6060

6161
### 💬 Web3 Telegram
6262

6363
Send privacy-preserving Telegram messages without knowing or storing their
6464
Telegram handles.
6565
[Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp)
66-
| [Documentation](../../tools/web3telegram.md)
66+
| [Documentation](../../use-iapp/web3telegram)
6767

6868
### 🌐 Content Delivery
6969

7070
Transfer, sell or rent protected content to authorized users.
7171
[Github](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/protected-data-delivery-dapp)
72-
| [Documentation](../../tools/dataProtector/dataProtectorSharing)
72+
| [Documentation](../../manage-data/dataProtector/dataProtectorSharing)
7373

7474
<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">
75-
<p class="m-0!">These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our <a href="../../tools/iapp-generator" target="_blank">documentation</a> and see what you can build!</p>
75+
<p class="m-0!">These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our <a href="../../build-iapp/iapp-generator" target="_blank">documentation</a> and see what you can build!</p>
7676
</div>
7777

7878
## 💾 Installation (win / mac / linux)
7979

8080
First, you need to install the `iapp` package. Open your terminal and run:
8181

82-
```sh
82+
::: code-group
83+
84+
```sh [npm]
8385
npm i -g @iexec/iapp
8486
```
8587

88+
```sh [yarn]
89+
yarn global add @iexec/iapp
90+
```
91+
92+
```sh [pnpm]
93+
pnpm add -g @iexec/iapp
94+
```
95+
96+
```sh [bun]
97+
bun add -g @iexec/iapp
98+
```
99+
100+
:::
101+
86102
You can check if the installation was successful by running:
87103

88104
```sh

src/overview/helloWorld/4-manageDataAccess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Want to see it in action? Check out our
108108
- Track your earnings
109109

110110
For more technical details, see the
111-
[DataProtector Sharing](../../tools/dataProtector/dataProtectorSharing.html)
111+
[DataProtector Sharing](../../manage-data/dataProtector/dataProtectorSharing)
112112
documentation.
113113

114114
<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">

src/overview/how-to-pay-for-web3mail.md

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

src/overview/use-case-demo.md

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

0 commit comments

Comments
 (0)