Skip to content

Commit b6da421

Browse files
committed
fix: standardize capitalization and formatting in documentation
1 parent bfc10c3 commit b6da421

18 files changed

+36
-34
lines changed

.vitepress/config.mts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export default defineConfig({
2828
},
2929
// Expose environment variables to the client
3030
define: {
31-
'import.meta.env.VITE_REOWN_PROJECT_ID': JSON.stringify(env.VITE_REOWN_PROJECT_ID),
31+
'import.meta.env.VITE_REOWN_PROJECT_ID': JSON.stringify(
32+
env.VITE_REOWN_PROJECT_ID
33+
),
3234
},
3335
},
3436
srcDir: './src',

src/build-iapp/guides/debugging.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Debugging Your iApp
2+
title: Debugging your iApp
33
description:
44
Troubleshoot and optimize your iApp execution in the TEE environment
55
---
@@ -24,7 +24,7 @@ Understanding how your task progresses through the iExec network:
2424

2525
**Most failures happen during stages 2-4**
2626

27-
## Monitoring Your Tasks
27+
## Monitoring your Tasks
2828

2929
### iExec Explorer
3030

@@ -112,7 +112,7 @@ with open(f"{os.environ['IEXEC_OUT']}/computed.json", 'w') as f:
112112
json.dump(computed, f)
113113
```
114114

115-
### ⚠️ **Dataset type unmatching**
115+
### ⚠️ **Dataset Type Unmatching**
116116

117117
- **Cause**: The dataset type specified in the frontend (protectData) does not
118118
match with the dataset type specified in the iApp

src/build-iapp/guides/how-to-get-and-decrypt-results.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ result.zip
146146
└── metadata.json # Optional metadata
147147
```
148148

149-
### computed.json Structure
149+
### `computed.json` Structure
150150

151151
**Always present in every result**:
152152

src/build-iapp/guides/inputs-and-outputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ result_data = {
403403
with open(f"{iexec_out}/result.json", 'w') as f:
404404
json.dump(result_data, f)
405405

406-
# REQUIRED: Create computed.json metadata
406+
# REQUIRED: Create `computed.json` metadata
407407
computed_metadata = {
408408
"deterministic-output-path": f"{iexec_out}/result.json",
409409
"execution-timestamp": "2024-01-15T10:30:00Z",

src/build-iapp/guides/manage-access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ generated private key. You can use this existing private key to initialize your
123123
wallet:
124124

125125
```bash
126-
# Extract the private key from your iexecconfig.json
126+
# Extract the private key from your `iexecconfig.json`
127127
iexec wallet import <your-private-key-from-iexecconfig>
128128
```
129129

@@ -204,7 +204,7 @@ Completely invalidate an order:
204204
iexec order cancel --app <orderHash>
205205
```
206206

207-
### 🛡️ **Confidential App (TEE required)**
207+
### 🛡️ **Confidential App (TEE Required)**
208208

209209
```json
210210
{

src/build-iapp/iapp-generator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ minutes, not months.
1313
(iApps)** - applications that run inside **Trusted Execution Environments
1414
(TEE)** for maximum privacy and security.
1515

16-
### What You Can Build
16+
### What you Can Build
1717

1818
- **AI models** that process sensitive data privately
1919
- **Data analysis** tools that protect user information

src/build-iapp/iapp-generator/building-your-iexec-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🧑‍🏭 Build Your iApp
1+
# 🧑‍🏭 Build your iApp
22

33
## 🧰 Initialize your iApp
44

@@ -7,7 +7,7 @@ guiding you through a step-by-step initialization process. This ensures your
77
iApp is correctly configured and compatible with iExec’s confidential computing
88
environment.
99

10-
### 🏗 Define Your Project
10+
### 🏗 Define your Project
1111

1212
Run:
1313

src/build-iapp/iapp-generator/deserializer/getValue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ const value1 = await deserializer.getValue(
5656
);
5757
```
5858

59-
## Return value
59+
## Return Value
6060

6161
The recovered original value.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: What Is an iApp?
2+
title: What is an iApp?
33
description: Privacy-first applications that run on decentralized infrastructure
44
---
55

6-
# 🚀 What Is an iApp?
6+
# 🚀 What is an iApp?
77

88
An iExec Application (iApp) is your regular application code (Python script, AI
99
model, data processor, ...) that can securely process protected data (created by
1010
[DataProtector](/manage-data/dataProtector)) inside a confidential computing
1111
environment called TEE (a Trusted Execution Environment).
1212

13-
## Why iApps Matter?
13+
## Why iApps Matter ?
1414

1515
iApps let you process sensitive data while keeping it private and secure.
1616

@@ -61,7 +61,7 @@ they will.**
6161
</div>
6262
</div>
6363

64-
## How It Works
64+
## How it Works
6565

6666
Your code runs in a Trusted Execution Environment (TEE), a secure area inside
6767
specific processors (Intel SGX/TDX chipset). Everything that happens there stays

src/manage-data/dataProtector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ ownership of protected data, enabling collaboration and potential **monetization
2626
opportunities**. This module empowers users to share and manage their data
2727
securely, fostering innovation and collaboration in the digital realm.
2828

29-
## Which one to use?
29+
## Which One to Use?
3030

3131
With `DataProtector Core`, you can **grant access** to your protected data **to
3232
a specific user**.

0 commit comments

Comments
 (0)