From 6e6db2c3e491271f34c65e845f16be67e8dbf3eb Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 25 Sep 2025 10:13:52 +0200 Subject: [PATCH 01/11] feat(docs): restructure iApp Generator documentation and add new guides --- src/references/iapp-generator/cli.md | 0 .../iapp-generator/{ => cli}/building-your-iexec-app.md | 0 src/references/iapp-generator/{ => cli}/deserializer.md | 0 src/references/iapp-generator/{ => cli}/deserializer/getValue.md | 0 src/references/iapp-generator/{ => cli}/getting-started.md | 0 src/references/iapp-generator/sdk.md | 0 6 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 src/references/iapp-generator/cli.md rename src/references/iapp-generator/{ => cli}/building-your-iexec-app.md (100%) rename src/references/iapp-generator/{ => cli}/deserializer.md (100%) rename src/references/iapp-generator/{ => cli}/deserializer/getValue.md (100%) rename src/references/iapp-generator/{ => cli}/getting-started.md (100%) create mode 100644 src/references/iapp-generator/sdk.md diff --git a/src/references/iapp-generator/cli.md b/src/references/iapp-generator/cli.md new file mode 100644 index 00000000..e69de29b diff --git a/src/references/iapp-generator/building-your-iexec-app.md b/src/references/iapp-generator/cli/building-your-iexec-app.md similarity index 100% rename from src/references/iapp-generator/building-your-iexec-app.md rename to src/references/iapp-generator/cli/building-your-iexec-app.md diff --git a/src/references/iapp-generator/deserializer.md b/src/references/iapp-generator/cli/deserializer.md similarity index 100% rename from src/references/iapp-generator/deserializer.md rename to src/references/iapp-generator/cli/deserializer.md diff --git a/src/references/iapp-generator/deserializer/getValue.md b/src/references/iapp-generator/cli/deserializer/getValue.md similarity index 100% rename from src/references/iapp-generator/deserializer/getValue.md rename to src/references/iapp-generator/cli/deserializer/getValue.md diff --git a/src/references/iapp-generator/getting-started.md b/src/references/iapp-generator/cli/getting-started.md similarity index 100% rename from src/references/iapp-generator/getting-started.md rename to src/references/iapp-generator/cli/getting-started.md diff --git a/src/references/iapp-generator/sdk.md b/src/references/iapp-generator/sdk.md new file mode 100644 index 00000000..e69de29b From ea0832d22263e7b27579cc086a450d726c8cad7f Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 25 Sep 2025 10:45:24 +0200 Subject: [PATCH 02/11] feat(docs): update iApp Generator links to reflect CLI structure and add new Getting Started guide --- .vitepress/sidebar.ts | 30 ++++++++++++++----- src/get-started/helloWorld/3-buildIApp.md | 2 +- src/get-started/toolkit.md | 2 +- src/guides/build-iapp/build-&-test.md | 2 +- src/guides/build-iapp/deploy-&-run.md | 2 +- src/guides/build-iapp/inputs.md | 2 +- .../dataProtectorCore/protectData.md | 2 +- src/references/iapp-generator.md | 8 ++--- src/references/iapp-generator/cli.md | 0 .../cli/building-your-iexec-app.md | 2 +- .../iapp-generator/getting-started.md | 6 ++++ src/references/iapp-generator/sdk.md | 0 12 files changed, 39 insertions(+), 19 deletions(-) delete mode 100644 src/references/iapp-generator/cli.md create mode 100644 src/references/iapp-generator/getting-started.md delete mode 100644 src/references/iapp-generator/sdk.md diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 92129a28..1768debb 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -447,20 +447,34 @@ export function getSidebar() { link: '/references/iapp-generator/getting-started', }, { - text: 'Building your iApp', - link: '/references/iapp-generator/building-your-iexec-app', - }, - { - text: 'Deserialize ProtectedData', - link: '/references/iapp-generator/deserializer', + text: 'CLI', collapsed: true, items: [ { - text: 'getValue', - link: '/references/iapp-generator/deserializer/getValue', + 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: 'SDK', + link: '/references/iapp-generator/sdk', + }, ], }, { diff --git a/src/get-started/helloWorld/3-buildIApp.md b/src/get-started/helloWorld/3-buildIApp.md index 24db293c..55b7b5eb 100644 --- a/src/get-started/helloWorld/3-buildIApp.md +++ b/src/get-started/helloWorld/3-buildIApp.md @@ -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 diff --git a/src/get-started/toolkit.md b/src/get-started/toolkit.md index e39ba702..327cbb9b 100644 --- a/src/get-started/toolkit.md +++ b/src/get-started/toolkit.md @@ -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 diff --git a/src/guides/build-iapp/build-&-test.md b/src/guides/build-iapp/build-&-test.md index 757fa4da..af7928d6 100644 --- a/src/guides/build-iapp/build-&-test.md +++ b/src/guides/build-iapp/build-&-test.md @@ -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 diff --git a/src/guides/build-iapp/deploy-&-run.md b/src/guides/build-iapp/deploy-&-run.md index 0dfb1510..4f85eced 100644 --- a/src/guides/build-iapp/deploy-&-run.md +++ b/src/guides/build-iapp/deploy-&-run.md @@ -74,7 +74,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).