Skip to content

Commit d531ddf

Browse files
committed
fix: enhance iApp documentation with improved formatting and clarity
- 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.
1 parent 09190eb commit d531ddf

File tree

1 file changed

+110
-47
lines changed

1 file changed

+110
-47
lines changed

src/build-iapp/what-is-iapp.md

Lines changed: 110 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,32 @@ Environment).
1212

1313
## Why iApps Matter?
1414

15-
Simple: **to process sensitive data that users won't normally share.**
15+
<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">
16+
<p class="m-0!"><strong>iApps let you process sensitive data while keeping it private and secure.</strong></p>
17+
</div>
1618

1719
Imagine you want to build:
1820

19-
- An AI that analyzes personal health data
20-
- An email tool that needs access to contact lists
21-
- A financial advisor that processes bank statements
22-
- A content filter that reads private messages
21+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
22+
<div class="flex flex-col gap-2.5">
23+
<div class="flex items-center gap-2 text-base">
24+
<span>🤖</span>
25+
<span>An AI that analyzes personal health data</span>
26+
</div>
27+
<div class="flex items-center gap-2 text-base">
28+
<span>📧</span>
29+
<span>An email tool that needs access to contact lists</span>
30+
</div>
31+
<div class="flex items-center gap-2 text-base">
32+
<span>💰</span>
33+
<span>A financial advisor that processes bank statements</span>
34+
</div>
35+
<div class="flex items-center gap-2 text-base">
36+
<span>🛡️</span>
37+
<span>A content filter that reads private messages</span>
38+
</div>
39+
</div>
40+
</div>
2341

2442
Users have this data, but they won't give it to your regular app. **With iApps,
2543
they will.**
@@ -30,14 +48,14 @@ Your code runs in a Trusted Execution Environment (TEE) a secure area inside
3048
specific processors (Intel SGX/TDX chipset). Everything that happens there stays
3149
private and protected, even from the operating system.
3250

33-
An authorized user can trigger an iApp that processes someone’s protected data
34-
inside this private environment. The data is used, but never exposed, not even
35-
to the person running the app.
51+
<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">
52+
<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>
53+
</div>
3654

3755
## iApp Generator: Your Development Tool
3856

39-
Generate and deploy iApps that will give you access to TEEs in just a few
40-
minutes.
57+
Bootstrap TEE-compatible applications in minutes without any hardcoding skills,
58+
iApp Generator handles all the low-level complexity for you.
4159

4260
- **Access to TEEs easily** - No need to dive into low-level requirements, build
4361
iApps that connect to TEE in minutes
@@ -58,8 +76,9 @@ iapp test
5876
iapp deploy
5977
```
6078

61-
_Note: iApp Generator currently supports Python and Node.js, but iApps can be
62-
built in any language that runs in Docker._
79+
<div class="bg-gradient-to-r from-blue-400/10 to-blue-400/5 rounded-[6px] p-4 border-l-4 border-blue-600 mb-6">
80+
<p class="m-0! text-sm"><strong>Note:</strong> iApp Generator currently supports Python and Node.js, but iApps can be built in any language that runs in Docker.</p>
81+
</div>
6382

6483
## Real Examples
6584

@@ -112,11 +131,34 @@ Here's why users will actually use your iApp with their private data:
112131

113132
### The Workflow
114133

115-
```
116-
User's Private Data → Encrypted → TEE Environment → Your iApp uses it → Actions Performed
117-
```
118-
119-
**Nobody sees the raw data except your code running inside the secure enclave.**
134+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
135+
<div class="flex flex-col gap-3">
136+
<div class="flex items-center gap-3">
137+
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">1</span>
138+
<span>User provides personal data</span>
139+
</div>
140+
<div class="flex items-center gap-3">
141+
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">2</span>
142+
<span>Data is protected with DataProtector</span>
143+
</div>
144+
<div class="flex items-center gap-3">
145+
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">3</span>
146+
<span>Protected data transferred to Trusted Execution Environment (TEE)</span>
147+
</div>
148+
<div class="flex items-center gap-3">
149+
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">4</span>
150+
<span>Your iApp runs inside TEE and processes protected data</span>
151+
</div>
152+
<div class="flex items-center gap-3">
153+
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">5</span>
154+
<span>Actions performed while maintaining privacy</span>
155+
</div>
156+
</div>
157+
</div>
158+
159+
<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">
160+
<p class="m-0!"><strong>Nobody sees the raw data except your code running inside the secure enclave.</strong></p>
161+
</div>
120162

121163
Your iApp can send emails, update contracts, make transactions, trigger
122164
notifications - anything your code needs to do with the protected data. This
@@ -125,25 +167,39 @@ preserved.
125167

126168
## What This Enables
127169

128-
### 📧 **Private Communication**
129-
130-
Users send emails, notifications, or messages using their protected contact
131-
lists without exposing recipient information.
132-
133-
### 🔮 **Trustworthy Oracles**
134-
135-
Users contribute real data to oracles while keeping their private information
136-
confidential.
137-
138-
### 🤖 **Personal AI Assistants**
139-
140-
Users let AI models perform actions based on their private data - trading,
141-
scheduling, recommendations.
142-
143-
### **Automated Actions**
144-
145-
Users set up automated workflows that use their private data to trigger actions,
146-
transactions, or updates.
170+
<div class="grid grid-cols-1 md:grid-cols-2 gap-6 my-6">
171+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
172+
<div class="flex items-baseline gap-2 text-lg">
173+
<span>📧</span>
174+
<h3 class="font-semibold m-0!">Private Communication</h3>
175+
</div>
176+
<p class="text-sm m-0!">Users send emails, notifications, or messages using their protected contact lists without exposing recipient information.</p>
177+
</div>
178+
179+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
180+
<div class="flex items-baseline gap-2 text-lg">
181+
<span>🔮</span>
182+
<h3 class="font-semibold m-0!">Trustworthy Oracles</h3>
183+
</div>
184+
<p class="text-sm m-0!">Users contribute real data to oracles while keeping their private information confidential.</p>
185+
</div>
186+
187+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
188+
<div class="flex items-baseline gap-2 text-lg">
189+
<span>🤖</span>
190+
<h3 class="font-semibold m-0!">Personal AI Assistants</h3>
191+
</div>
192+
<p class="text-sm m-0!">Users let AI models perform actions based on their private data - trading, scheduling, recommendations.</p>
193+
</div>
194+
195+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
196+
<div class="flex items-baseline gap-2 text-lg">
197+
<span>⚡</span>
198+
<h3 class="font-semibold m-0!">Automated Actions</h3>
199+
</div>
200+
<p class="text-sm m-0!">Users set up automated workflows that use their private data to trigger actions, transactions, or updates.</p>
201+
</div>
202+
</div>
147203

148204
## ❓ Frequently Asked Questions
149205

@@ -187,17 +243,24 @@ Node.js for simplified development.
187243

188244
## Why This Changes Everything
189245

190-
**True Privacy**: Users never expose their raw data. Your app processes it
191-
privately inside secure enclaves.
192-
193-
**Verifiable Execution**: Cryptographic proof that your code ran exactly as
194-
intended. No black box execution.
195-
196-
**Decentralized Infrastructure**: No single point of failure. Your app runs
197-
across a distributed network of workers.
198-
199-
**Zero Trust Architecture**: Users don't need to trust you with their data.
200-
The protocol guarantees privacy.
246+
<div class="grid grid-cols-1 md:grid-cols-2 gap-4 mb-6">
247+
<div class="flex items-center gap-3">
248+
<span class="text-green-500 text-xl">✅</span>
249+
<p class="m-0"><strong>True Privacy:</strong> Users never expose their raw data. Your app processes it privately inside secure enclaves.</p>
250+
</div>
251+
<div class="flex items-center gap-3">
252+
<span class="text-green-500 text-xl">✅</span>
253+
<p class="m-0"><strong>Verifiable Execution:</strong> Cryptographic proof that your code ran exactly as intended. No black box execution.</p>
254+
</div>
255+
<div class="flex items-center gap-3">
256+
<span class="text-green-500 text-xl">✅</span>
257+
<p class="m-0"><strong>Decentralized Infrastructure:</strong> No single point of failure. Your app runs across a distributed network of workers.</p>
258+
</div>
259+
<div class="flex items-center gap-3">
260+
<span class="text-green-500 text-xl">✅</span>
261+
<p class="m-0"><strong>Zero Trust Architecture:</strong> Users don't need to trust you with their data. The protocol guarantees privacy.</p>
262+
</div>
263+
</div>
201264

202265
## Start Building
203266

0 commit comments

Comments
 (0)