Skip to content

Commit 9f1b39d

Browse files
authored
feat: simplify doc as debug mode disappear (#42)
1 parent 3851738 commit 9f1b39d

31 files changed

+1104
-1925
lines changed

.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export default withMermaid(
101101
// https://vitepress.dev/reference/default-theme-config
102102
nav: [
103103
{ text: 'Get Started', link: '/get-started/welcome' },
104-
{ text: 'Guides', link: '/guides/build-iapp/build-&-deploy' },
104+
{ text: 'Guides', link: '/guides/build-iapp/build-&-test' },
105105
{ text: 'References', link: '/references/dataProtector' },
106106
{
107107
component: 'ChainSelector',

.vitepress/sidebar.ts

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,12 @@ export function getSidebar() {
166166
text: 'BUILD YOUR iAPP',
167167
items: [
168168
{
169-
text: 'Build and Deploy',
170-
link: '/guides/build-iapp/build-&-deploy',
169+
text: 'Build and Test',
170+
link: '/guides/build-iapp/build-&-test',
171+
},
172+
{
173+
text: 'Deploy and Run',
174+
link: '/guides/build-iapp/deploy-&-run',
171175
},
172176
{
173177
text: 'Manage Access',
@@ -181,10 +185,6 @@ export function getSidebar() {
181185
text: 'Using TDX',
182186
link: '/guides/build-iapp/using-tdx',
183187
},
184-
{
185-
text: 'How to Get and Decrypt Results',
186-
link: '/guides/build-iapp/how-to-get-and-decrypt-results',
187-
},
188188
{
189189
text: 'Debugging',
190190
link: '/guides/build-iapp/debugging',
@@ -241,16 +241,12 @@ export function getSidebar() {
241241
link: '/guides/use-iapp/getting-started',
242242
},
243243
{
244-
text: 'Different Ways to Execute an iApp',
245-
link: '/guides/use-iapp/different-ways-to-execute',
246-
},
247-
{
248-
text: 'Use iApp with Protected Data',
249-
link: '/guides/use-iapp/use-iapp-with-protected-data',
244+
text: 'Run iApp with ProtectedData',
245+
link: '/guides/use-iapp/run-iapp-with-ProtectedData',
250246
},
251247
{
252-
text: 'Add Inputs to the Execution',
253-
link: '/guides/use-iapp/add-inputs-to-execution',
248+
text: 'Run iApp without ProtectedData',
249+
link: '/guides/use-iapp/run-iapp-without-ProtectedData',
254250
},
255251
{
256252
text: 'How to Pay the Executions',
@@ -606,7 +602,7 @@ export function getSidebar() {
606602
link: '/references/sdk',
607603
},
608604
{
609-
text: '📖 Glossary',
605+
text: '📖 Glossary',
610606
link: '/references/glossary',
611607
},
612608
],

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,3 +252,7 @@ for input parameters:
252252
- Talk about ENS on Bellecour(it's not supported on arbitrum)
253253
- Rework Advanced iApp building guides. (from "old" protocol doc)
254254
- Rework src\get-started\protocol\oracle.md (transfer to guide or rewrite)
255+
- Talk about iApp secret
256+
- Improve Guide in build-iapp section - be more clear for builder ( how to
257+
process process protectedData, clarify input-output guide)
258+
- refactor iapp generator cli reference

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ const arbitrumSteps = [
489489
},
490490
{
491491
showAt: 13,
492-
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7 on dockerhub',
492+
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
493493
answer: '',
494494
showTyping: false,
495495
isComplete: true
@@ -558,7 +558,7 @@ const bellecourSteps = [
558558
},
559559
{
560560
showAt: 12,
561-
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7 on dockerhub',
561+
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
562562
answer: '',
563563
showTyping: false,
564564
isComplete: true
@@ -573,12 +573,12 @@ const bellecourSteps = [
573573
];
574574

575575
const arbitrumCompletionItems = [
576-
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7',
576+
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
577577
'└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
578578
];
579579

580580
const bellecourCompletionItems = [
581-
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7',
581+
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
582582
'└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
583583
];
584584
</script>

src/get-started/overview/what-is-iexec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description:
1010
iExec is a **decentralized confidential computing toolkit** that helps
1111
developers build privacy-preserving applications.
1212

13-
## The Protocol (Simple Version)
13+
## SpeedRun The Protocol
1414

1515
### Step 1: Protect Data
1616

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,6 @@ The environment you are about to use is a "develop" environment:
7979
- where configurations and secrets might be inspected (debug enclaves)
8080

8181
When your developer discovery journey is complete, please reach the
82-
[production section](/guides/build-iapp/build-&-deploy#go-to-production).
82+
[production section](/guides/build-iapp/build-&-test#go-to-production).
8383

8484
:::

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ indeed whitelisted for it.
1818

1919
The SMS currently supports 3 types of secrets:
2020

21-
1. [Application developer secret](/guides/build-iapp/build-&-deploy#application-developer-secret):
21+
1. [Application developer secret](/guides/build-iapp/build-&-test#application-developer-secret):
2222
This secret is directly accessible from the application as an environment
2323
variable. It is owned by the developer of the application. It can be any kind
2424
of data (API key, private key, token, ..) as long as it respects the size
@@ -58,6 +58,4 @@ graph TD
5858
You now understand how these three kinds of confidential assets work on iExec,
5959
you can go one step further by learning how to manipulate them:
6060

61-
- [Attach a secret to your app](/guides/build-iapp/build-&-deploy#application-developer-secret)
62-
- [Access requester secrets](/guides/build-iapp/inputs-and-outputs#access-requester-secrets)
6361
- [Access a confidential dataset](sgx-encrypted-dataset.md)

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,4 +344,3 @@ You are now familiar with the following key iExec concepts for developers:
344344
Continue with these guides:
345345

346346
- [Learn how to build your first application running on iExec](your-first-app.md)
347-
- [Learn how to manage your apporders](/guides/build-iapp/build-&-deploy#manage-your-apporders)

src/guides/build-iapp/advanced/sgx-encrypted-dataset.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,4 @@ an encrypted dataset in a Confidential Computing application.
363363

364364
To go further, check out how to:
365365

366-
- [Attach a secret to your app](/guides/build-iapp/build-&-deploy#application-developer-secret)
367-
- [Access requester secrets](/guides/build-iapp/inputs-and-outputs#access-requester-secrets)
368366
- [Protect the result](end-to-end-encryption.md)

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,3 @@ iExec:
413413
- using docker to package your app with all its dependencies
414414
- testing an iExec app locally
415415
- publishing on dockerhub
416-
417-
Resources:
418-
419-
- A list of iExec applications with their Docker images can be found at
420-
[https://github.com/iExecBlockchainComputing/iexec-apps](https://github.com/iExecBlockchainComputing/iexec-apps)
421-
422-
Continue with these articles:
423-
424-
- [Confidential app](/guides/build-iapp/build-&-deploy#confidential-app)
425-
- [Learn how to manage your apporders](/guides/build-iapp/build-&-deploy#manage-your-apporders)

0 commit comments

Comments
 (0)