Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3d9b559
fix: Refactor documentation and code examples for iApp result handling
Le-Caignec Aug 18, 2025
7ca2d4b
chore: Remove outdated CLI examples and batch operation section from …
Le-Caignec Aug 18, 2025
bee1b91
refactor: Update iApp execution guides and remove outdated content
Le-Caignec Aug 18, 2025
1c8d83f
refactor: Improve formatting and clarity in iApp execution guide
Le-Caignec Aug 19, 2025
889b382
docs: Enhance iApp execution guide with structured methods and code e…
Le-Caignec Aug 19, 2025
6387871
docs: Update iApp guide titles for consistency and clarity
Le-Caignec Aug 19, 2025
b9d6d41
docs: Update iApp guides to reflect new testing and deployment structure
Le-Caignec Aug 19, 2025
0ce8913
docs: Revise iApp deployment and execution guides for clarity and str…
Le-Caignec Aug 19, 2025
9e25439
docs: Update iApp guides for improved clarity and consistency
Le-Caignec Aug 19, 2025
d523212
docs: Enhance 'Deploy and Run' guide with deployment and run tracking…
Le-Caignec Aug 19, 2025
6a0dae4
docs: Refactor iApp guides for improved clarity and structure
Le-Caignec Aug 19, 2025
1f58f63
docs: Update iApp guides for improved navigation and clarity
Le-Caignec Aug 19, 2025
ae19db1
docs: Reorder iApp sidebar links for improved navigation
Le-Caignec Aug 19, 2025
d7ed5ea
docs: Revise iApp guides to clarify input options and usage
Le-Caignec Aug 19, 2025
00fe80a
docs: Improve readability of iApp guides by breaking long lines
Le-Caignec Aug 19, 2025
7348db2
docs: Add prerequisites section to 'Run iApp without ProtectedData' g…
Le-Caignec Aug 19, 2025
e21678e
docs: Remove 'Next Steps' sections from iApp execution guides
Le-Caignec Aug 19, 2025
03624ef
docs: Remove Output Retrieval section from iApp inputs and outputs guide
Le-Caignec Aug 19, 2025
7ecbbec
docs: Fix emoji display in sidebar for Glossary link
Le-Caignec Aug 19, 2025
ac5cc51
docs: Enhance build-iapp section for clarity and refactor CLI reference
Le-Caignec Aug 19, 2025
a64b777
docs: add TODO
Le-Caignec Aug 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export default withMermaid(
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Get Started', link: '/get-started/welcome' },
{ text: 'Guides', link: '/guides/build-iapp/build-&-deploy' },
{ text: 'Guides', link: '/guides/build-iapp/build-&-test' },
{ text: 'References', link: '/references/dataProtector' },
{
component: 'ChainSelector',
Expand Down
26 changes: 11 additions & 15 deletions .vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,12 @@ export function getSidebar() {
text: 'BUILD YOUR iAPP',
items: [
{
text: 'Build and Deploy',
link: '/guides/build-iapp/build-&-deploy',
text: 'Build and Test',
link: '/guides/build-iapp/build-&-test',
},
{
text: 'Deploy and Run',
link: '/guides/build-iapp/deploy-&-run',
},
{
text: 'Manage Access',
Expand All @@ -181,10 +185,6 @@ export function getSidebar() {
text: 'Using TDX',
link: '/guides/build-iapp/using-tdx',
},
{
text: 'How to Get and Decrypt Results',
link: '/guides/build-iapp/how-to-get-and-decrypt-results',
},
{
text: 'Debugging',
link: '/guides/build-iapp/debugging',
Expand Down Expand Up @@ -241,16 +241,12 @@ export function getSidebar() {
link: '/guides/use-iapp/getting-started',
},
{
text: 'Different Ways to Execute an iApp',
link: '/guides/use-iapp/different-ways-to-execute',
},
{
text: 'Use iApp with Protected Data',
link: '/guides/use-iapp/use-iapp-with-protected-data',
text: 'Run iApp with ProtectedData',
link: '/guides/use-iapp/run-iapp-with-ProtectedData',
},
{
text: 'Add Inputs to the Execution',
link: '/guides/use-iapp/add-inputs-to-execution',
text: 'Run iApp without ProtectedData',
link: '/guides/use-iapp/run-iapp-without-ProtectedData',
},
{
text: 'How to Pay the Executions',
Expand Down Expand Up @@ -606,7 +602,7 @@ export function getSidebar() {
link: '/references/sdk',
},
{
text: '📖 Glossary',
text: '📖 Glossary',
link: '/references/glossary',
},
],
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,7 @@ for input parameters:
- Talk about ENS on Bellecour(it's not supported on arbitrum)
- Rework Advanced iApp building guides. (from "old" protocol doc)
- Rework src\get-started\protocol\oracle.md (transfer to guide or rewrite)
- Talk about iApp secret
- Improve Guide in build-iapp section - be more clear for builder ( how to
process process protectedData, clarify input-output guide)
- refactor iapp generator cli reference
8 changes: 4 additions & 4 deletions src/get-started/helloWorld/3-buildIApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ const arbitrumSteps = [
},
{
showAt: 13,
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7 on dockerhub',
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
answer: '',
showTyping: false,
isComplete: true
Expand Down Expand Up @@ -558,7 +558,7 @@ const bellecourSteps = [
},
{
showAt: 12,
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7 on dockerhub',
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
answer: '',
showTyping: false,
isComplete: true
Expand All @@ -573,12 +573,12 @@ const bellecourSteps = [
];

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

const bellecourCompletionItems = [
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-debug-ce3a01d9c5d7',
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
'└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
];
</script>
2 changes: 1 addition & 1 deletion src/get-started/overview/what-is-iexec.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
iExec is a **decentralized confidential computing toolkit** that helps
developers build privacy-preserving applications.

## The Protocol (Simple Version)
## SpeedRun The Protocol

Check warning on line 13 in src/get-started/overview/what-is-iexec.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/overview/what-is-iexec.md#L13

[Google.Headings] 'SpeedRun The Protocol' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'SpeedRun The Protocol' should use sentence-style capitalization.", "location": {"path": "src/get-started/overview/what-is-iexec.md", "range": {"start": {"line": 13, "column": 4}}}, "severity": "WARNING"}

### Step 1: Protect Data

Expand Down
2 changes: 1 addition & 1 deletion src/get-started/protocol/tee/intel-sgx-technology.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@ The environment you are about to use is a "develop" environment:
- where configurations and secrets might be inspected (debug enclaves)

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

:::
4 changes: 1 addition & 3 deletions src/guides/build-iapp/advanced/access-confidential-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ indeed whitelisted for it.

The SMS currently supports 3 types of secrets:

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

- [Attach a secret to your app](/guides/build-iapp/build-&-deploy#application-developer-secret)
- [Access requester secrets](/guides/build-iapp/inputs-and-outputs#access-requester-secrets)
- [Access a confidential dataset](sgx-encrypted-dataset.md)
Original file line number Diff line number Diff line change
Expand Up @@ -344,4 +344,3 @@ You are now familiar with the following key iExec concepts for developers:
Continue with these guides:

- [Learn how to build your first application running on iExec](your-first-app.md)
- [Learn how to manage your apporders](/guides/build-iapp/build-&-deploy#manage-your-apporders)
2 changes: 0 additions & 2 deletions src/guides/build-iapp/advanced/sgx-encrypted-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,4 @@ an encrypted dataset in a Confidential Computing application.

To go further, check out how to:

- [Attach a secret to your app](/guides/build-iapp/build-&-deploy#application-developer-secret)
- [Access requester secrets](/guides/build-iapp/inputs-and-outputs#access-requester-secrets)
- [Protect the result](end-to-end-encryption.md)
10 changes: 0 additions & 10 deletions src/guides/build-iapp/advanced/your-first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,13 +413,3 @@ iExec:
- using docker to package your app with all its dependencies
- testing an iExec app locally
- publishing on dockerhub

Resources:

- A list of iExec applications with their Docker images can be found at
[https://github.com/iExecBlockchainComputing/iexec-apps](https://github.com/iExecBlockchainComputing/iexec-apps)

Continue with these articles:

- [Confidential app](/guides/build-iapp/build-&-deploy#confidential-app)
- [Learn how to manage your apporders](/guides/build-iapp/build-&-deploy#manage-your-apporders)
Loading