feat: build iapp by martin #15
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…clarity - Updated the iApp Generator section to emphasize ease of access to TEEs and quick deployment. - Added details on project mode selection and language options for better user guidance.
…ructure - Changed the section title from "The Technical Reality" to "The Workflow" for better alignment with user understanding. - Enhanced the FAQ section by restructuring questions and answers for improved readability and clarity, ensuring users can easily find information about building, speed, security, deployment, and programming language support for iApps.
…ution features - Revised the "Why This Changes Everything" section to improve clarity and emphasis on key features such as True Privacy, Verifiable Execution, Decentralized Infrastructure, and Zero Trust Architecture. - Consolidated information for better readability and user understanding of iApp's secure processing capabilities.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
- Updated the "Why iApps Matter?" section to emphasize the importance of processing sensitive data securely. - Enhanced the workflow explanation with a clearer, step-by-step visual format for better user understanding. - Improved the presentation of key features and use cases with visually distinct sections for better readability. - Added notes on iApp Generator capabilities and supported languages in a more accessible format.
…otected data - Reintroduced the section on how users provide protected data, ensuring clear instructions and code examples for executing iApps. - Improved the formatting and structure of the documentation to align with recent updates, enhancing overall readability and user understanding.
- Introduced a new section addressing potential dataset type mismatches between the frontend and iApp, outlining causes and solutions for better user guidance. - Enhanced overall documentation clarity to assist users in debugging their iApps effectively.
…ration details - Added a new comparison table highlighting key differences between Intel SGX and Intel TDX, including release year, enclave scope, memory size, and integration complexity. - Enhanced the guide to clarify the benefits of TDX for heavier workloads and legacy applications, improving user understanding of its capabilities. - Updated the section on enabling TDX in the iApp Generator for better guidance on integration.
- Added a warning section detailing the syntax for setting environment variables on different operating systems (Mac/Linux and Windows) to enhance user understanding and ensure proper configuration for TDX applications.
- Changed the Docker requirement to specify the need for a Docker hub account, enhancing user understanding of prerequisites for using the iApp Generator.
…on details - Added instructions for configuring the iExec DataProtector SDK with the correct SMS endpoint for TDX support. - Included a warning about changing the default worker pool in the protected Data declaration to ensure proper functionality.
Le-Caignec
commented
Aug 7, 2025
src/build-iapp/what-is-iapp.md
Outdated
| to run inside secure enclaves. | ||
| An iExec Application (iApp) is your regular application code (Python script, AI | ||
| model, data processor) that can securely process protected data (created by | ||
| DataProtector) inside a privacy-safe environment called TEE (a Trusted Execution |
There was a problem hiding this comment.
Suggested change
| DataProtector) inside a privacy-safe environment called TEE (a Trusted Execution | |
| DataProtector) inside a confidential computing environment called TEE (a Trusted Execution |
src/build-iapp/what-is-iapp.md
Outdated
Comment on lines
15
to
17
| <div class="bg-gradient-to-r from-purple-400/10 to-purple-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6"> | ||
| <p class="m-0!"><strong>iApps let you process sensitive data while keeping it private and secure.</strong></p> | ||
| </div> |
There was a problem hiding this comment.
Suggested change
| <div class="bg-gradient-to-r from-purple-400/10 to-purple-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6"> | |
| <p class="m-0!"><strong>iApps let you process sensitive data while keeping it private and secure.</strong></p> | |
| </div> | |
| iApps let you process sensitive data while keeping it private and secure. |
src/build-iapp/what-is-iapp.md
Outdated
| it - all without you ever seeing the raw data. | ||
| <div class="bg-gradient-to-r from-fuchsia-400/10 to-fuchsia-400/5 rounded-[6px] p-6 border-l-4 border-fuchsia-700 mb-6"> | ||
| <p class="m-0!">An authorized user can trigger an iApp that processes someone's protected data inside this private environment. The data is used, but never exposed, not even to the person running the app.</p> | ||
| </div> | ||
|
|
||
| ## iApp Generator: Your Development Tool |
There was a problem hiding this comment.
This content shouldn’t be on this page — it’s not related to the topic in my opinion. We should move it to a guide instead.
…, and emerging trends
- Added a new section detailing the trust benefits for users and builders, emphasizing control over data and the advantages of privacy-preserving features. - Improved the presentation of key concepts with clearer formatting and visual elements for better user understanding.
- Deleted the section outlining trust benefits for users and builders, which included details on data control and privacy features. - This change aims to streamline the documentation and focus on more relevant content for users.
- Updated the description of iApps to include a link to DataProtector for better context. - Added a comma in the "How It Works" section to enhance readability and ensure proper sentence structure.
There was a problem hiding this comment.
Pull Request Overview
This PR significantly refactors the iApp documentation structure and content to improve clarity and user experience. The changes modernize the documentation with enhanced visual elements and reorganized information flow.
Key Changes
- Complete redesign of the "What Is an iApp?" documentation with improved visual components
- Addition of a new "Build and Deploy an iApp" guide with practical examples
- Enhanced TDX documentation with comparison tables and clearer configuration instructions
Reviewed Changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/build-iapp/what-is-iapp.md | Major redesign with modern UI components, restructured content flow, and enhanced visual elements |
| src/build-iapp/guides/build-&-deploy-iapp.md | New comprehensive guide for building and deploying iApps with practical examples |
| src/build-iapp/guides/using-tdx-experimental.md | Enhanced with SGX vs TDX comparison table and improved configuration instructions |
| src/build-iapp/guides/inputs-and-outputs.md | Minor restructuring of protected data section |
| src/build-iapp/guides/debugging-your-iapp.md | Added dataset type mismatch troubleshooting |
| src/build-iapp/iapp-generator/getting-started.md | Updated Docker requirements to include Docker Hub account |
| .vitepress/sidebar.ts | Added new guide to navigation structure |
| @@ -77,6 +95,30 @@ EXPERIMENTAL_TDX_APP=true iapp debug <taskId> | |||
| iexec app show <app-address> | |||
| ``` | |||
|
|
|||
| ### | |||
There was a problem hiding this comment.
Empty heading section detected. This appears to be an incomplete markdown heading that should either be completed with descriptive text or removed.
Suggested change
| ### |
Copilot uses AI. Check for mistakes.
- Revised the initial task scheduling description to specify that it takes a few seconds, improving clarity. - Corrected the link path for the iApp Generator section to ensure accurate navigation. - Changed the "Start Building" section to "Next Steps" and restructured the content to enhance readability and user engagement, including new links to relevant guides and documentation.
- Revised the iApp Generator section to clarify the process of building TEE-compatible applications, emphasizing ease of access and deployment. - Improved the language for selecting project modes and languages, making it more user-friendly and accessible for developers of varying experience levels.
- Changed "Verifiable Execution" to "Trusted Execution" to reflect the use of Trusted Execution Environments (TEEs) for secure code execution. - Revised the description of "Zero Trust Architecture" to emphasize hardware-based TEEs for data protection. - Updated terminology from "personal data" to "private data" for consistency and clarity. - Enhanced real-world examples of iApps with additional context and code snippets in both Python and Node.js, ensuring better understanding of their functionality and privacy preservation.
This was referenced Aug 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.