Skip to content

Commit ea0832d

Browse files
committed
feat(docs): update iApp Generator links to reflect CLI structure and add new Getting Started guide
1 parent 6e6db2c commit ea0832d

File tree

12 files changed

+39
-19
lines changed

12 files changed

+39
-19
lines changed

.vitepress/sidebar.ts

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -447,20 +447,34 @@ export function getSidebar() {
447447
link: '/references/iapp-generator/getting-started',
448448
},
449449
{
450-
text: 'Building your iApp',
451-
link: '/references/iapp-generator/building-your-iexec-app',
452-
},
453-
{
454-
text: 'Deserialize ProtectedData',
455-
link: '/references/iapp-generator/deserializer',
450+
text: 'CLI',
456451
collapsed: true,
457452
items: [
458453
{
459-
text: 'getValue',
460-
link: '/references/iapp-generator/deserializer/getValue',
454+
text: 'Getting Started',
455+
link: '/references/iapp-generator/cli/getting-started',
456+
},
457+
{
458+
text: 'Building your iApp',
459+
link: '/references/iapp-generator/cli/building-your-iexec-app',
460+
},
461+
{
462+
text: 'Deserialize ProtectedData',
463+
link: '/references/iapp-generator/cli/deserializer',
464+
collapsed: true,
465+
items: [
466+
{
467+
text: 'getValue',
468+
link: '/references/iapp-generator/cli/deserializer/getValue',
469+
},
470+
],
461471
},
462472
],
463473
},
474+
{
475+
text: 'SDK',
476+
link: '/references/iapp-generator/sdk',
477+
},
464478
],
465479
},
466480
{

src/get-started/helloWorld/3-buildIApp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ experience.
2727
## 📋 Prerequisites
2828

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

3333
::: info

src/get-started/toolkit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ just a few commands, let free your imagination.
2424
### Get Started
2525

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

2929
## DataProtector-SDK
3030

src/guides/build-iapp/build-&-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ iApp Generator handles all the low-level complexity for you.
3030
## Prerequisites
3131

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

3636
## Quick Start

src/guides/build-iapp/deploy-&-run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The iApp Generator CLI provides a streamlined way to execute iApp, especially
7474
for developers who have built their own iApp.
7575

7676
> **Note**: For installation instructions, see the
77-
> [iApp Generator Getting Started guide](/references/iapp-generator/getting-started).
77+
> [iApp Generator Getting Started guide](/references/iapp-generator/cli/getting-started).
7878
7979
<template v-if="selectedChain === 42161">
8080
<CLIDemo

src/guides/build-iapp/inputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ App Secrets are different from Requester Secrets:
384384

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

389389
#### Configuration in iapp.config.json
390390

src/references/dataProtector/dataProtectorCore/protectData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ details on the transaction using the [iExec explorer](https://explorer.iex.ec).
362362
Under the hood, your protected data will be **compressed as a zip file**. In
363363
this zip file, you'll find back all of your protected fields, each field being
364364
serialized with a tool called `Borsh`. You can find more details here:
365-
[deserializer](/references/iapp-generator/deserializer).
365+
[deserializer](/references/iapp-generator/cli/deserializer).
366366

367367
This is mainly returned for debug purpose.
368368

src/references/iapp-generator.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Start here to understand what iApp are and how they work:
3232

3333
- **[iApp](/get-started/overview/privacy-iapp)** - Core concepts and TEE
3434
overview
35-
- **[Getting Started](/references/iapp-generator/getting-started)** - Your first
36-
iApp in 15 minutes
37-
- **[Building Your iApp](/references/iapp-generator/building-your-iexec-app)** -
35+
- **[Getting Started](/references/iapp-generator/cli/getting-started)** - Your
36+
first iApp in 15 minutes
37+
- **[Building Your iApp](/references/iapp-generator/cli/building-your-iexec-app)** -
3838
Complete development guide
3939

4040
### 2. **Master the Development Workflow**
@@ -87,7 +87,7 @@ applications:
8787

8888
::: tip Quick Path
8989

90-
1. **[Getting Started](/references/iapp-generator/getting-started)** - Build
90+
1. **[Getting Started](/references/iapp-generator/cli/getting-started)** - Build
9191
your first iApp (15 minutes)
9292
2. **[Inputs](/guides/build-iapp/inputs)** - Handle data inputs
9393
3. **[Outputs](/guides/build-iapp/outputs)** - Handle data outputs properly

src/references/iapp-generator/cli.md

Whitespace-only changes.

src/references/iapp-generator/cli/building-your-iexec-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description:
1010
::: tip 📋 Prerequisites
1111

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

1616
:::

0 commit comments

Comments
 (0)