Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6e6db2c
feat(docs): restructure iApp Generator documentation and add new guides
Le-Caignec Sep 25, 2025
ea0832d
feat(docs): update iApp Generator links to reflect CLI structure and …
Le-Caignec Sep 25, 2025
c838c64
feat: add @mage-sombre/iapp dependency and update sidebar with new SD…
Le-Caignec Sep 25, 2025
d34e91f
refactor(docs): update DataProtector and iApp types documentation for…
Le-Caignec Sep 25, 2025
841ed30
fix(docs): update transferOwnership and types documentation to reflec…
Le-Caignec Sep 25, 2025
a69ccb4
refactor(docs): update iApp documentation to enhance clarity and cons…
Le-Caignec Sep 25, 2025
b3f7b12
refactor(docs): update iApp references in SDK documentation for consi…
Le-Caignec Sep 25, 2025
dfd592c
refactor(docs): improve clarity and consistency in iApp and DataProte…
Le-Caignec Sep 25, 2025
d9c98db
refactor(docs): consolidate iApp usage guides by removing outdated Pr…
Le-Caignec Oct 1, 2025
f824730
fix(docs): correct formatting in run-iApp documentation for better re…
Le-Caignec Oct 1, 2025
389405d
Merge branch 'main' into feature/integrate-iapp
Le-Caignec Oct 1, 2025
7a70702
refactor(docs): streamline iApp documentation by unifying references …
Le-Caignec Oct 1, 2025
19aa9ce
Merge branch 'feature/integrate-iapp' of https://github.com/iExecBloc…
Le-Caignec Oct 1, 2025
57da9ca
Merge branch 'main' into feature/integrate-iapp
Le-Caignec Oct 6, 2025
83ef0b1
Merge branch 'main' into feature/integrate-iapp
Le-Caignec Oct 16, 2025
1516708
Merge remote-tracking branch 'origin/main' into feature/integrate-iapp
Le-Caignec Oct 16, 2025
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
72 changes: 60 additions & 12 deletions .vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,8 @@ export function getSidebar() {
link: '/guides/use-iapp/how-to-pay-executions',
},
{
text: 'Run iApp with ProtectedData',
link: '/guides/use-iapp/run-iapp-with-ProtectedData',
},
{
text: 'Run iApp without ProtectedData',
link: '/guides/use-iapp/run-iapp-without-ProtectedData',
text: 'Run iApp',
link: '/guides/use-iapp/run-iapp',
},
{
text: 'Integrate Web3 Messaging',
Expand Down Expand Up @@ -281,17 +277,69 @@ export function getSidebar() {
link: '/references/iapp-generator/getting-started',
},
{
text: 'Building your iApp',
link: '/references/iapp-generator/building-your-iexec-app',
text: 'CLI',
collapsed: true,
items: [
{
text: 'Getting Started',
link: '/references/iapp-generator/cli/getting-started',
},
{
text: 'Building your iApp',
link: '/references/iapp-generator/cli/building-your-iexec-app',
},
{
text: 'Deserialize ProtectedData',
link: '/references/iapp-generator/cli/deserializer',
collapsed: true,
items: [
{
text: 'getValue',
link: '/references/iapp-generator/cli/deserializer/getValue',
},
],
},
],
},
{
text: 'Deserialize ProtectedData',
link: '/references/iapp-generator/deserializer',
text: 'SDK',
collapsed: true,
items: [
{
text: 'getValue',
link: '/references/iapp-generator/deserializer/getValue',
text: 'getIApp',
link: '/references/iapp-generator/sdk/getIApp',
},
{
text: 'transferOwnership',
link: '/references/iapp-generator/sdk/transferOwnership',
},
{
text: 'grantAccess',
link: '/references/iapp-generator/sdk/grantAccess',
},
{
text: 'getGrantedAccess',
link: '/references/iapp-generator/sdk/getGrantedAccess',
},
{
text: 'revokeOneAccess',
link: '/references/iapp-generator/sdk/revokeOneAccess',
},
{
text: 'revokeAllAccess',
link: '/references/iapp-generator/sdk/revokeAllAccess',
},
{
text: 'runIApp',
link: '/references/iapp-generator/sdk/runIApp',
},
{
text: 'getResultFromCompletedTask',
link: '/references/iapp-generator/sdk/getResultFromCompletedTask',
},
{
text: 'Types',
link: '/references/iapp-generator/sdk/types',
},
],
},
Expand Down
16 changes: 16 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"@iexec/dataprotector-deserializer": "^0.1.1",
"@iexec/web3mail": "^1.6.0",
"@iexec/web3telegram": "^0.1.0-alpha.4",
"@mage-sombre/iapp": "^1.0.0-beta.2",
"@reown/appkit": "^1.7.17",
"@reown/appkit-adapter-wagmi": "^1.7.17",
"@tailwindcss/vite": "^4.1.11",
Expand Down
2 changes: 1 addition & 1 deletion src/get-started/helloWorld/3-buildIApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ experience.
## 📋 Prerequisites

Before getting started, make sure you have the required tools installed. See the
[iApp Generator Getting Started guide](/references/iapp-generator/getting-started)
[iApp Generator Getting Started guide](/references/iapp-generator/cli/getting-started)
for detailed prerequisites and installation instructions.

::: info
Expand Down
2 changes: 1 addition & 1 deletion src/get-started/toolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ just a few commands, let free your imagination.
### Get Started

Jump right into building with our comprehensive guide:
[Building Your iApp →](/references/iapp-generator/building-your-iexec-app.md)
[Building Your iApp →](/references/iapp-generator/cli/building-your-iexec-app.md)

## DataProtector-SDK

Expand Down
5 changes: 2 additions & 3 deletions src/guides/build-iapp/build-&-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ iApp Generator handles all the low-level complexity for you.
## Prerequisites

Before getting started, make sure you have the required tools installed. See the
[iApp Generator Getting Started guide](/references/iapp-generator/getting-started)
[iApp Generator Getting Started guide](/references/iapp-generator/cli/getting-started)
for detailed prerequisites and installation instructions.

## Quick Start
Expand Down Expand Up @@ -164,8 +164,7 @@ The CLI will build a Docker image, run your app, and show you the results:

## Next Steps

- When everything is ready
[deploy and run your iApp](/guides/use-iapp/run-iapp-with-ProtectedData)
- When everything is ready [deploy and run your iApp](/guides/use-iapp/run-iapp)

<script setup>
import CLIDemo from '@/components/CLIDemo.vue';
Expand Down
2 changes: 1 addition & 1 deletion src/guides/build-iapp/deploy-&-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The iApp Generator CLI provides a streamlined way to execute iApp, especially
for developers who have built their own iApp.

> **Note**: For installation instructions, see the
> [iApp Generator Getting Started guide](/references/iapp-generator/getting-started).
> [iApp Generator Getting Started guide](/references/iapp-generator/cli/getting-started).

<template v-if="selectedChain === 42161">
<CLIDemo
Expand Down
2 changes: 1 addition & 1 deletion src/guides/build-iapp/inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ App Secrets are different from Requester Secrets:

App Secrets are configured in your `iapp.config.json` during development and
automatically deployed with your iApp. For deployment details, see the
[Build Your iApp guide](/references/iapp-generator/building-your-iexec-app).
[Build Your iApp guide](/references/iapp-generator/cli/building-your-iexec-app).

#### Configuration in iapp.config.json

Expand Down
7 changes: 3 additions & 4 deletions src/guides/use-iapp/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ the Build iApp section.

For step-by-step instructions, check out these guides:

- **[Run iApp without ProtectedData](/guides/use-iapp/run-iapp-without-ProtectedData)** -
iExec CLI, lib, and other execution methods
- **[Run iApp with ProtectedData](/guides/use-iapp/run-iapp-with-ProtectedData)** -
How to provide data and parameters to iApp
- **[Run iApp](/guides/use-iapp/run-iapp)** - Learn how to run an iApp with
various input types including protected data, arguments, input files, and
secrets
- **[How to Pay for Executions](/guides/use-iapp/how-to-pay-executions)** -
Understanding costs and payment options
10 changes: 3 additions & 7 deletions src/guides/use-iapp/how-to-pay-executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,8 @@ await iexec.account.deposit(1_000_000_000); // Deposit 1 RLC
```

Now you are ready to run a task on the iExec Protocol and pay for it. See our
guide on
[running iApp with ProtectedData](/guides/use-iapp/run-iapp-with-ProtectedData.md)
for detailed execution steps.
guide on [running iApp](/guides/use-iapp/run-iapp.md) for detailed execution
steps.

## Paying with Vouchers <ChainNotSupportedBadge />

Expand Down Expand Up @@ -231,10 +230,7 @@ parameters is 0, which means only free resources are accepted.

Now that you understand payment methods:

- Learn about
[Run iApp with ProtectedData](/guides/use-iapp/run-iapp-with-ProtectedData)
- Learn about
[Run iApp without ProtectedData](/guides/use-iapp/run-iapp-without-ProtectedData)
- Learn about [Run iApp](/guides/use-iapp/run-iapp)

<script setup>
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
Expand Down
Loading