Skip to content

Commit 0b8bded

Browse files
committed
chore: enhance documentation with new titles and descriptions for clarity
- Added titles and descriptions to several guides, including "iExec Oracle," "Access Confidential Assets from Your App," "Build Your First Application with Scone Framework," and "Build Intel TDX App (Experimental)." - Updated links in various TEE guides to reflect the new "Deploy & Run" terminology. - Improved clarity in the "Quick Start for Developers" guide by integrating specific chain names into command examples.
1 parent f85de92 commit 0b8bded

File tree

10 files changed

+58
-22
lines changed

10 files changed

+58
-22
lines changed

src/get-started/protocol/oracle.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: iExec Oracle
23
description: A flexible and secure Oracle Solution
34
---
45

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

Lines changed: 1 addition & 1 deletion
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-
- **[Build & Deploy](/guides/build-iapp/build-&-deploy)** - Create your first
145+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
146146
SGX 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,5 +144,5 @@ graph TD
144144

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

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

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

Lines changed: 1 addition & 1 deletion
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-
- **[Build & Deploy](/guides/build-iapp/build-&-deploy)** - Create your first
124+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
125125
TEE application

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

Lines changed: 1 addition & 1 deletion
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-
- **[Build & Deploy](/guides/build-iapp/build-&-deploy)** - Create your first
84+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Create your first
8585
TEE application

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

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

310
::: warning
@@ -55,4 +62,4 @@ graph TD
5562
You now understand how these three kinds of confidential assets work on iExec,
5663
you can go one step further by learning how to manipulate them:
5764

58-
- [Access to a Protected Data](guides/build-iapp/inputs-and-outputs)
65+
- [Access to a Protected Data](/guides/build-iapp/inputs-and-outputs)

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Build Your First Application with Scone Framework
3+
description:
4+
Learn how to build and run Confidential Computing applications with the Scone
5+
TEE framework for secure, privacy-preserving computation
6+
---
7+
18
# Build your first application with Scone framework
29

310
In this tutorial, you will learn how to build and run a Confidential Computing

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Build Intel TDX App (Experimental)
3+
description:
4+
Learn how to build and run Confidential Computing applications with Intel TDX
5+
technology using both traditional deployment and the iApp Generator
6+
---
7+
18
# 🛡️ Build Intel TDX App (Experimental) <ChainNotSupportedBadge/>
29

310
In this tutorial, you will learn how to build and run a Confidential Computing
@@ -103,7 +110,7 @@ Your `iexec.json` should now look like this example:
103110
"checksum": "<checksum>", // starts with 0x, update it with your own image digest
104111
"mrenclave": {
105112
"framework": "TDX", // TEE framework (keep default value)
106-
}
113+
}
107114
},
108115
...
109116
}
@@ -296,7 +303,7 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
296303
**[Intel SGX Technology](/get-started/protocol/tee/intel-sgx)** for production
297304
- **[Create Your First SGX App](/guides/build-iapp/advanced/create-your-first-sgx-app)** -
298305
Build production-ready SGX applications
299-
- **[Build & Deploy](/guides/build-iapp/build-&-deploy)** - Standard iApp
306+
- **[Deploy & Run](/guides/build-iapp/deploy-&-run)** - Standard iApp
300307
deployment guide
301308

302309
### 🔗 **Related Resources**
@@ -307,7 +314,7 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
307314
Generator documentation
308315
- **[DataProtector SDK](/references/dataProtector)** - Work with protected data
309316
in TDX
310-
- **[Advanced iApp Building](/guides/build-iapp/advanced/overview)** - Advanced
317+
- **[Advanced iApp Building](/guides/build-iapp/advanced/quick-start-for-developers)** - Advanced
311318
development techniques
312319

313320
<script setup>

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: End-to-End Encryption
3+
description:
4+
Learn how to implement end-to-end encryption for your Confidential Computing
5+
applications to protect results and ensure complete data privacy
6+
---
7+
18
# Protect the result
29

310
In previous tutorials, we saw how to build
@@ -104,9 +111,9 @@ mkdir /tmp/trash && \
104111
`iexec_out/result.zip` :
105112

106113
```bash
107-
)3�Xq��Yv��ȿzE�fRu<\�ݵm�m���疞r���c��(a���{{'��ܼ���͛�q/[{����H�t>��������h��gD$g��\.�k��j�����"�s?"�h�J�_Q41�_[{��X��������Ԛ��a�蘟v���E����r����肽
108-
�����Յ]9W�TL�*���
109-
�t��d���z��O`����!���e�&snoL3�K6L9���%
114+
)3XqYvȿzEfRu<mm疞rc(a{{'ܼ͛q/[{Ht>hgD$g\.kj"s?"hJ_Q41_[{XԚa蘟vEr肽
115+
Յ]9WTL*
116+
tdzO`!e&snoL3K6L9%
110117
```
111118
112119
Now you should decrypt the result by running:

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

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Quick Start for Developers
3+
description:
4+
Learn how to create and deploy decentralized applications on the iExec
5+
infrastructure using the iExec SDK command-line interface
6+
---
7+
18
# Quick Start
29

310
> In this tutorial we will show you how you can create decentralized application
@@ -135,21 +142,21 @@ You will now deploy your app on iExec, this will be your first transaction on
135142
the blockchain:
136143

137144
```bash twoslash
138-
iexec app deploy --chain {{chainName}}
145+
iexec app deploy --chain arbitrum-mainnet
139146
```
140147

141148
::: tip
142149

143150
While running `iexec app deploy` you sent your first transaction on the
144-
{{chainName}} blockchain.
151+
arbitrum-mainnet blockchain.
145152

146153
:::
147154

148155
You can check your deployed apps with their index, let's check your last
149156
deployed app:
150157

151158
```bash twoslash
152-
iexec app show --chain {{chainName}}
159+
iexec app show --chain arbitrum-mainnet
153160
```
154161

155162
## Run your app on iExec
@@ -174,20 +181,20 @@ At any time you can:
174181
- view your balance
175182

176183
```bash twoslash
177-
iexec account show --chain {{chainName}}
184+
iexec account show --chain arbitrum-mainnet
178185
```
179186

180187
- deposit RLC from your wallet to your iExec Account
181188

182189
```bash twoslash
183-
iexec account deposit --chain {{chainName}} <amount>
190+
iexec account deposit --chain arbitrum-mainnet <amount>
184191
```
185192

186193
- withdraw RLC from your iExec account to your wallet \(only stake can be
187194
withdrawn\)
188195

189196
```bash twoslash
190-
iexec account withdraw --chain {{chainName}} <amount>
197+
iexec account withdraw --chain arbitrum-mainnet <amount>
191198
```
192199

193200
:::
@@ -198,7 +205,7 @@ to pay for the computation.
198205
Everything is ready to run your application!
199206

200207
```bash twoslash
201-
iexec app run --chain {{chainName}} --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 prod-v8-learn.main.pools.iexec.eth --watch
202209
```
203210

204211
::: info
@@ -254,13 +261,13 @@ is a 32Bytes hexadecimal string\).
254261
Download the result of your task
255262

256263
```bash twoslash
257-
iexec task show --chain {{chainName}} <taskid> --download my-result
264+
iexec task show --chain arbitrum-mainnet <taskid> --download my-result
258265
```
259266

260267
You can get your taskid with the command:
261268

262269
```bash twoslash
263-
iexec deal show --chain {{chainName}} <dealid>
270+
iexec deal show --chain arbitrum-mainnet <dealid>
264271
```
265272

266273
::: info
@@ -302,7 +309,7 @@ The conditions to use an app are defined in the **apporder**.
302309
Publish a new apporder for your application.
303310

304311
```bash twoslash
305-
iexec app publish --chain {{chainName}}
312+
iexec app publish --chain arbitrum-mainnet
306313
```
307314

308315
::: info
@@ -321,7 +328,7 @@ conditions defined in apporder.
321328
You can check the published apporders for your app
322329

323330
```bash twoslash
324-
iexec orderbook app --chain {{chainName}} <your app address>
331+
iexec orderbook app --chain arbitrum-mainnet <your app address>
325332
```
326333

327334
Congratulation you just created a decentralized application! Anyone can now

0 commit comments

Comments
 (0)