From 708e4f56b8bc14b64a9e67d988d45f2d7eaa6e9c Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Tue, 28 Oct 2025 09:26:27 +0100 Subject: [PATCH 1/6] refactor: remove 'Getting Started' section from iApp sidebar and delete corresponding guide --- .vitepress/sidebar.ts | 4 -- src/guides/use-iapp/getting-started.md | 79 -------------------------- 2 files changed, 83 deletions(-) delete mode 100644 src/guides/use-iapp/getting-started.md diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 70d8f6c7..1a052845 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -192,10 +192,6 @@ export function getSidebar() { text: 'Introduction', link: '/guides/use-iapp/introduction', }, - { - text: 'Getting Started', - link: '/guides/use-iapp/getting-started', - }, { text: 'How to Pay the Executions', link: '/guides/use-iapp/how-to-pay-executions', diff --git a/src/guides/use-iapp/getting-started.md b/src/guides/use-iapp/getting-started.md deleted file mode 100644 index 5b3e213b..00000000 --- a/src/guides/use-iapp/getting-started.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Getting Started with iApp -description: Learn the basics of finding and executing iApp on the iExec network ---- - -# 🚀 Getting Started with iApp - -Welcome to secure, privacy-preserving computation! This guide shows you how to -use iApp on the iExec confidential computing network. - -### Prerequisites - -Before getting started, ensure that you have the following installed on your -system: - -\- [**Node.js**](https://nodejs.org/en/) version 18 or higher - -\- [**NPM**](https://docs.npmjs.com/) (Node.js package manager) - -### Installation - -::: 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 -``` - -::: - -Ready to dive in? Let's get started with finding and executing your first iApp! - -## Overview: How to Use iApp - -Using iApp involves these main steps: - -1. **Find iApp** - Browse available applications in the - [iExec Explorer](/get-started/tooling-and-explorers/iexec-explorer) -2. **Prepare Data** - Set up any required protected data or inputs -3. **Execute** - Run the iApp -4. **Get Results** - Retrieve your computation results - -### Understanding orders - -iApp are executed through a marketplace system where different actors publish -orders: - -- **App orders** - Published by developers with pricing and availability -- **Workerpool orders** - Published by computation providers with capacity and - pricing -- **Dataset orders** - Published by data owners with access conditions and - pricing - -When you execute an iApp, the system matches your request with available orders -from all three categories. For a deeper understanding of how orders work and how -to manage them, see the [Build & Test guide](/guides/build-iapp/build-&-test) in -the Build iApp section. - -## Detailed Guides - -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 -- **[How to Pay for Executions](/guides/use-iapp/how-to-pay-executions)** - - Understanding costs and payment options From c1056e5b184c9288a83c083cd1efcc2edff84bb8 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Tue, 28 Oct 2025 09:37:59 +0100 Subject: [PATCH 2/6] docs: update references to iExec SDK documentation across multiple guides for clarity and consistency --- src/guides/build-iapp/advanced/quick-start.md | 3 +++ src/guides/build-iapp/advanced/result-callback.md | 4 ++-- src/guides/build-iapp/manage-access.md | 8 ++++---- src/guides/build-iapp/outputs.md | 2 -- src/guides/use-iapp/introduction.md | 8 +++++--- src/guides/use-iapp/run-iapp-without-ProtectedData.md | 3 ++- src/references/sdk.md | 11 +++++++---- 7 files changed, 23 insertions(+), 16 deletions(-) diff --git a/src/guides/build-iapp/advanced/quick-start.md b/src/guides/build-iapp/advanced/quick-start.md index 3d502c47..becc20c3 100644 --- a/src/guides/build-iapp/advanced/quick-start.md +++ b/src/guides/build-iapp/advanced/quick-start.md @@ -18,6 +18,9 @@ test blockchain. ## Install the iExec SDK +For complete installation instructions and requirements, see the +[iExec SDK documentation](/references/sdk). + Requirements: [![npm version](https://img.shields.io/badge/nodejs-%3E=18.0.0-brightgreen.svg)](https://nodejs.org/en/) diff --git a/src/guides/build-iapp/advanced/result-callback.md b/src/guides/build-iapp/advanced/result-callback.md index 5b292acb..c2a48d04 100644 --- a/src/guides/build-iapp/advanced/result-callback.md +++ b/src/guides/build-iapp/advanced/result-callback.md @@ -106,8 +106,8 @@ contract address. After completion, the protocol calls your contract, passing the `callback-data` bytes. -First install the iExec SDK if you have not already (see -[Getting Started](/guides/use-iapp/getting-started)). +First install the iExec SDK if you have not already (see the +[iExec SDK documentation](/references/sdk)). ```ts twoslash import { IExec, utils } from 'iexec'; diff --git a/src/guides/build-iapp/manage-access.md b/src/guides/build-iapp/manage-access.md index 2d293750..c56f7fe0 100644 --- a/src/guides/build-iapp/manage-access.md +++ b/src/guides/build-iapp/manage-access.md @@ -28,7 +28,7 @@ Currently, order management is not yet available in iApp Generator. This guide shows you how to use the iExec SDK CLI to create and manage your app orders. For complete SDK documentation, check the -[iExec SDK GitHub repository](https://github.com/iExecBlockchainComputing/iexec-sdk). +[iExec SDK documentation](/references/sdk). ::: @@ -67,7 +67,8 @@ Here's an example app order for a sentiment analysis iApp: ### Step 1: Install the iExec SDK Since iApp Generator doesn't handle orders yet, you need to use the iExec SDK -CLI: +CLI. For detailed installation instructions, see the +[iExec SDK documentation](/references/sdk). ::: code-group @@ -304,8 +305,7 @@ Next steps: ### Technical deep dive -- **[iExec SDK Documentation](https://github.com/iExecBlockchainComputing/iexec-sdk)** - - Complete CLI reference +- **[iExec SDK Documentation](/references/sdk)** - Complete CLI reference