Skip to content

feat: rename core-concept to protocol #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export default defineConfig({
{ text: 'Protect Data', link: '/manage-data/what-is-protected-data' },
{ text: 'Build iApp', link: '/build-iapp/what-is-iapp' },
{ text: 'Use iApp', link: '/use-iapp/introduction' },
{ text: 'Core Concept', link: '/core-concept/glossary' },
{ text: 'Protocol', link: '/protocol/sdk' },
],
outline: {
level: [2, 4],
Expand Down
26 changes: 12 additions & 14 deletions .vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,6 @@ export function getSidebar() {
{ text: '🚀 Getting Started', link: '/use-iapp/getting-started' },
{
text: '📖 Guides',
link: '/use-iapp/guides',
items: [
{
text: 'Different ways to execute an iApp',
Expand All @@ -423,11 +422,11 @@ export function getSidebar() {
},
{
text: 'Use iApp with Protected Data',
link: '/use-iapp/use-iapp-with-protected-data',
link: '/use-iapp/guides/use-iapp-with-protected-data',
},
{
text: 'Find iApps to Use',
link: '/use-iapp/find-iapps',
link: '/use-iapp/guides/find-iapps',
},
{
text: 'How to pay the executions',
Expand All @@ -437,23 +436,22 @@ export function getSidebar() {
},
{
text: '💰 How to Pay',
link: '/use-iapp/payment',
items: [
{
text: 'How to Pay for Web3mail',
link: '/overview/how-to-pay-for-web3mail',
link: '/use-iapp/how-to-pay/how-to-pay-for-web3mail',
},
{
text: 'How to Pay for Web3telegram',
link: '/use-iapp/web3telegram/how-to-pay-for-web3telegram',
link: '/use-iapp/how-to-pay/how-to-pay-for-web3telegram',
},
{
text: 'Pricing Considerations',
link: '/overview/pricing-considerations',
link: '/use-iapp/how-to-pay/pricing-considerations',
},
{
text: 'Voucher Authorization Guide',
link: '/use-iapp/voucher-guide',
text: 'Voucher',
link: '/use-iapp/how-to-pay/voucher',
},
],
},
Expand Down Expand Up @@ -563,21 +561,21 @@ export function getSidebar() {
],
},
],
'/core-concept/': [
'/protocol/': [
{
text: 'CORE CONCEPTS',
text: 'PROTOCOL',
items: [
{
text: '🔧  iExec SDK',
link: '/core-concept/sdk',
link: '/protocol/sdk',
},
{
text: '⚙️  Workers & Workerpools',
link: '/core-concept/workers',
link: '/protocol/workers',
},
{
text: '📖  Glossary',
link: '/core-concept/glossary',
link: '/protocol/glossary',
},
],
},
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ Fork this repository and ensure you're working on the `main` branch:

## TODO

- Add an audit section
- Add Arbitrum support
- On arbitrum hide : Oracle Factory ? , DataProtector Sharing ??
- Adapt hardcoded address to feat with new contracts deployed on arbitrum
Expand All @@ -159,4 +160,4 @@ Fork this repository and ensure you're working on the `main` branch:
- complete `use-iapp` section
- complete `explorer` section
- complete `build-iapp` section
- complete `deep-dive`section
- complete `Protocol`section
6 changes: 3 additions & 3 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ features:
details:
Create revenue streams from your data while maintaining full control and
privacy
link: /manage-data/guides/monetize-protected-data
link: /use-iapp/how-to-pay/how-to-pay-for-web3mail
- icon: 🧠
title: Core Concepts
title: Protocols
details:
Deep dive into the core concepts of the protocol and understand how iExec
enables privacy, governance, and monetization
link: /core-concept/sdk
link: /protocol/sdk
---
2 changes: 1 addition & 1 deletion src/overview/helloWorld/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Computing</a></span> technologies.

iExec combines three fundamental elements that work together seamlessly:

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

- Encrypt your sensitive data and store it securely on Arweave or IPFS
- Only you control who can access it and when
Expand Down
18 changes: 17 additions & 1 deletion src/overview/helloWorld/2-protectData.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,26 @@ simple through our developer tools.
<p><strong>1. Install the Developer Tool</strong></p>
<p>Run the install command:</p>

```sh
::: code-group

```sh [npm]
npm install @iexec/dataprotector
```

```sh [yarn]
yarn add @iexec/dataprotector
```

```sh [pnpm]
pnpm add @iexec/dataprotector
```

```sh [bun]
bun add @iexec/dataprotector
```

:::

</div>
<div>
<p><strong>2. Import and Initialize it in your project</strong></p>
Expand Down
28 changes: 22 additions & 6 deletions src/overview/helloWorld/3-buildIApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import InfoIcon from '../../components/InfoIcon.vue'

<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">
<h2 class="text-2xl font-bold mt-0 border-none!">Time to build!</h2>
<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>
<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>
</div>

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

### 💬 Web3 Telegram

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

### 🌐 Content Delivery

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

<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">
<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>
<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>
</div>

## 💾 Installation (win / mac / linux)

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

```sh
::: code-group

```sh [npm]
npm i -g @iexec/iapp
```

```sh [yarn]
yarn global add @iexec/iapp
```

```sh [pnpm]
pnpm add -g @iexec/iapp
```

```sh [bun]
bun add -g @iexec/iapp
```

:::

You can check if the installation was successful by running:

```sh
Expand Down
2 changes: 1 addition & 1 deletion src/overview/helloWorld/4-manageDataAccess.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Want to see it in action? Check out our
- Track your earnings

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

<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">
Expand Down
10 changes: 0 additions & 10 deletions src/overview/how-to-pay-for-web3mail.md

This file was deleted.

34 changes: 0 additions & 34 deletions src/overview/use-case-demo.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file removed src/use-iapp/guides.md
Empty file.
File renamed without changes.
Loading