Skip to content

Commit 3286e45

Browse files
committed
docs: update TEE guides and command examples for clarity
- Improved phrasing in the "Deploy & Run" sections across multiple TEE guides for better readability. - Updated command examples to use dynamic workerpool addresses instead of hardcoded values in various advanced iApp documentation. - Enhanced clarity in the "Access Confidential Assets" guide by adjusting the description formatting.
1 parent d2f0056 commit 3286e45

File tree

14 files changed

+68
-31
lines changed

14 files changed

+68
-31
lines changed

src/get-started/protocol/tee/intel-sgx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ graph TD
142142

143143
**Ready to build with SGX?** Check out the practical guides:
144144

145-
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
146-
SGX application
145+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first SGX
146+
application
147147
- **[Advanced SGX Development](/guides/build-iapp/advanced/create-your-first-sgx-app)** -
148148
Deep dive into SGX development

src/get-started/protocol/tee/intel-tdx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,5 +144,5 @@ graph TD
144144

145145
**For production applications, use SGX**:
146146

147-
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create
148-
production-ready SGX applications
147+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create production-ready
148+
SGX applications

src/get-started/protocol/tee/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ TEE technologies have evolved to address different use cases:
121121

122122
- **[Build Intel TDX App (Experimental)](/guides/build-iapp/advanced/create-your-first-tdx-app)** -
123123
Build TDX applications with traditional deployment and iApp Generator
124-
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
125-
TEE application
124+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first TEE
125+
application

src/get-started/protocol/tee/sgx-vs-tdx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,5 @@ technology** for advanced use cases.
8181

8282
- **[Build Intel TDX App (Experimental)](/guides/build-iapp/advanced/create-your-first-tdx-app)** -
8383
Build TDX applications with traditional deployment and iApp Generator
84-
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
85-
TEE application
84+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first TEE
85+
application

src/guides/build-iapp/advanced/access-confidential-assets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Access Confidential Assets from Your App
33
description:
44
Learn how to access confidential assets including secrets, protected data, and
5-
requester secrets from your iExec application using the Secret Management Service
5+
requester secrets from your iExec application using the Secret Management
6+
Service
67
---
78

89
# Access confidential assets from your app

src/guides/build-iapp/advanced/create-your-first-sgx-app.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,20 +240,19 @@ iexec app deploy --chain {{chainName}}
240240

241241
Specify the tag `--tag tee,scone` in `iexec app run` command to run a tee app.
242242

243-
One last thing, in order to run a **TEE-debug** app you will also need to select
244-
a debug workerpool, use the debug workerpool
245-
`debug-v8-learn.main.pools.iexec.eth`.
243+
One last thing, in order to run a **TEE** app you will also need to select a
244+
workerpool, use the iexec workerpool `{{workerpoolAddress}}`.
246245

247246
You are now ready to run the app
248247

249248
```bash twoslash
250-
iexec app run --chain {{chainName}} --tag tee,scone --workerpool debug-v8-learn.main.pools.iexec.eth --watch
249+
iexec app run --chain {{chainName}} --tag tee,scone --workerpool {{workerpoolAddress}} --watch
251250
```
252251

253252
::: info
254253

255-
You noticed we used `debug-v8-learn.main.pools.iexec.eth` instead of an ethereum
256-
address, this is an ENS name.
254+
You noticed we used `{{workerpoolAddress}}` instead of an ethereum address, this
255+
is an ENS name.
257256

258257
:::
259258

@@ -285,4 +284,5 @@ const selectedChain = computed(() => userStore.getCurrentChainId());
285284

286285
const chainData = computed(() => getChainById(selectedChain.value));
287286
const chainName = computed(() => chainData.value.chainName);
287+
const workerpoolAddress = computed(() => chainData.value.workerpoolAddress);
288288
</script>

src/guides/build-iapp/advanced/create-your-first-tdx-app.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,8 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
303303
**[Intel SGX Technology](/get-started/protocol/tee/intel-sgx)** for production
304304
- **[Create Your First SGX App](/guides/build-iapp/advanced/create-your-first-sgx-app)** -
305305
Build production-ready SGX applications
306-
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Standard iApp
307-
deployment guide
306+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Standard iApp deployment
307+
guide
308308

309309
### 🔗 **Related Resources**
310310

@@ -314,8 +314,8 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
314314
Generator documentation
315315
- **[DataProtector SDK](/references/dataProtector)** - Work with protected data
316316
in TDX
317-
- **[Advanced iApp Building](/guides/build-iapp/advanced/quick-start-for-developers)** - Advanced
318-
development techniques
317+
- **[Advanced iApp Building](/guides/build-iapp/advanced/quick-start-for-developers)** -
318+
Advanced development techniques
319319

320320
<script setup>
321321
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'

src/guides/build-iapp/advanced/end-to-end-encryption.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ the beneficiary in the command:
8787
```bash twoslash
8888
iexec app run <0x-your-app-address> \
8989
--chain {{chainName}}
90-
--workerpool debug-v8-learn.main.pools.iexec.eth \
90+
--workerpool {{workerpoolAddress}} \
9191
--tag tee,scone \
9292
--encrypt-result \
9393
--watch
@@ -154,4 +154,5 @@ const selectedChain = computed(() => userStore.getCurrentChainId());
154154
155155
const chainData = computed(() => getChainById(selectedChain.value));
156156
const chainName = computed(() => chainData.value.chainName);
157+
const workerpoolAddress = computed(() => chainData.value.workerpoolAddress);
157158
</script>

src/guides/build-iapp/advanced/quick-start-for-developers.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ to pay for the computation.
205205
Everything is ready to run your application!
206206

207207
```bash twoslash
208-
iexec app run --chain arbitrum-mainnet --args <your-name-here> --workerpool prod-v8-learn.main.pools.iexec.eth --watch
208+
iexec app run --chain arbitrum-mainnet --args <your-name-here> --workerpool {{workerpoolAddress}} --watch
209209
```
210210

211211
::: info
@@ -217,7 +217,7 @@ Useful options:
217217
- `--args <args>` specify the app execution arguments
218218
- `--watch` watch execution status changes
219219
- `--workerpool <address>` specify the workerpool to use (for example:
220-
`--workerpool prod-v8-learn.main.pools.iexec.eth`)
220+
`--workerpool {{workerpoolAddress}}`)
221221

222222
Discover more option with `iexec app run --help`
223223

@@ -361,4 +361,5 @@ const selectedChain = computed(() => userStore.getCurrentChainId());
361361

362362
const chainData = computed(() => getChainById(selectedChain.value));
363363
const chainName = computed(() => chainData.value.chainName);
364+
const workerpoolAddress = computed(() => chainData.value.workerpoolAddress);
364365
</script>

src/guides/build-iapp/advanced/your-first-app.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ iexec app show --chain {{chainName}}
336336
### Run your app on iExec
337337

338338
```bash twoslash
339-
iexec app run --chain {{chainName}} --workerpool debug-v8-learn.main.pools.iexec.eth --watch
339+
iexec app run --chain {{chainName}} --workerpool {{workerpoolAddress}} --watch
340340
```
341341

342342
::: info
@@ -426,4 +426,5 @@ const selectedChain = computed(() => userStore.getCurrentChainId());
426426

427427
const chainData = computed(() => getChainById(selectedChain.value));
428428
const chainName = computed(() => chainData.value.chainName);
429+
const workerpoolAddress = computed(() => chainData.value.workerpoolAddress);
429430
</script>

0 commit comments

Comments
 (0)