Skip to content

Commit 4363944

Browse files
committed
chore: update documentation to standardize terminology and improve clarity
1 parent 2782f75 commit 4363944

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+400
-203
lines changed
Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
# Technical terms for iExec documentation
2+
3+
# Function Names
4+
protectData
5+
grantAccess
6+
revokeAllAccess
7+
revokeOneAccess
8+
transferOwnership
9+
createCollection
10+
removeCollection
11+
removeProtectedDataFromCollection
12+
sendEmail
13+
sendTelegram
14+
getValue
15+
deserializer
16+
deserialize
17+
consumeProtectedData
18+
rentProtectedData
19+
subscribeToCollection
20+
buyProtectedData
21+
setProtectedDataForSale
22+
setProtectedDataToRenting
23+
setProtectedDataToSubscription
24+
setProtectedDataRentingParams
25+
setSubscriptionParams
26+
addToCollection
27+
removeProtectedDataFromCollection
28+
removeProtectedDataFromRenting
29+
removeProtectedDataForSale
30+
addAppToAddOnlyAppWhitelist
31+
createAddOnlyAppWhitelist
32+
getUserAddOnlyAppWhitelist
33+
getGrantedAccess
34+
getProtectedData
35+
getResultFromCompletedTask
36+
getCollectionOwners
37+
getCollectionsByOwner
38+
getCollectionSubscriptions
39+
getProtectedDataInCollections
40+
getProtectedDataPricingParams
41+
getRentals
42+
fetchMyContacts
43+
fetchUserContacts
44+
unpublish
45+
46+
# Function Parameters
47+
authorizedApp
48+
authorizedUser
49+
grantedAccess
50+
collectionId
51+
appsWhitelist
52+
userWhitelist
53+
useVoucher
54+
voucherAddress
55+
voucherOwner
56+
subscriberAddress
57+
renterAddress
58+
apporder
59+
datasetorder
60+
workerpoolorder
61+
requestorder
62+
requesters
63+
workerpools
64+
apporders
65+
appmaxprice
66+
datasetmaxprice
67+
workerpoolmaxprice
68+
apprestrict
69+
requesterrestrict
70+
workerpoolrestrict
71+
datasetprice
72+
taskId
73+
dealId
74+
userAddress
75+
resultHash
76+
resultSeal
77+
enclaveSign
78+
workerpoolSign
79+
inputFiles
80+
zipFile
81+
encryptionKey
82+
multiaddr
83+
ipfsNode
84+
ipfsGateway
85+
emailSubject
86+
emailContent
87+
contentType
88+
senderName
89+
telegramContent
90+
//TODO: check
91+
param
92+
params
93+
args
94+
environnement
95+
pageSize
96+
subgraphUrl
97+
subgraph
98+
iexecOptions
99+
uploadMode
100+
allowDebug
101+
requiredSchema
102+
keypair
103+
collectionOwner
104+
isRentable
105+
isDistributed
106+
NFTs
107+
creationTimestamp
108+
transactionHash
109+
txHash
110+
boolean
111+
bigint
112+
newOwner
113+
maxPrice
114+
workerpoolorders
115+
116+
# iExec/Web3 Terms
117+
iExec
118+
CPUs
119+
LLMs
120+
Agentic
121+
DApp
122+
DApps
123+
blockchain
124+
ethereum
125+
intel
126+
nano
127+
workerpool
128+
protectedData
129+
dataProtector
130+
iApp
131+
sconification
132+
middleware
133+
oracle
134+
MREnclave
135+
Gramine
136+
//TODO: check
137+
permissioning
138+
Permissioning
139+
arithmetics
140+
webservers
141+
Javascript
142+
Dockerizable
143+
Dockerize
144+
Dockerhub
145+
dockerized
146+
keystore
147+
Webpack
148+
json
149+
polyfills
150+
Buildx
151+
hardcoding
152+
npm
153+
Arweave
154+
cryptocurrency
155+
cryptocurrencies
156+
crypto
157+
onchain
158+
offchain
159+
//TODO: check
160+
mainchain
161+
Sidechain
162+
Bellecour
163+
Mainnet
164+
Testnet
165+
Metamask
166+
Binance
167+
Coinbase
168+
Uniswap
169+
Szabo
170+
presale
171+
presigned
172+
untrusted
173+
dev
174+
cryptocurrecny
175+
Unmatching
176+
incentivized
177+
Whitepaper
178+
deserialization
179+
enclaveChallenge
180+
Borsh
181+
Arbitrum
182+
Stargate
183+
Github
184+
subgraphs
185+
hackathons
186+
tokenization
187+
chipset
188+
auditable
189+
Composable
190+
Activable
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Terms to reject - currently empty
2+
# Add terms here that should always be flagged as errors

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ components.d.ts
1414
.DS_Store
1515

1616
#vale
17-
.github/styles/*
17+
.github/styles/config/*
18+
!.github/styles/config/vocabularies/

.vale.ini

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@ StylesPath = .github/styles
22
MinAlertLevel = suggestion
33
Packages = Google
44

5+
# Define the Technical vocabulary for custom terminology
6+
Vocab = Technical
7+
58
[formats]
69
md = markdown
710

811
[*.md]
912
BasedOnStyles = Vale, Google
1013
IgnorePatterns = README.md
14+
15+
# Disable Vale.Terms to avoid case sensitivity issues
16+
Vale.Terms = NO

src/get-started/helloWorld.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Hello World Tutorial
33
description:
44
Kickstart your Web3 journey with iExec. In just 30 minutes, learn how to build
5-
privacy-focused dApps, protect sensitive data, and manage data access.
5+
privacy-focused DApp, protect sensitive data, and manage data access.
66
---
77

88
<script setup>
@@ -12,7 +12,7 @@ import ChainSelector from '@/components/ChainSelector.vue'
1212

1313
# 👋 Welcome to iExec
1414

15-
> Reading time 🕒 2 mins
15+
> Reading time 🕒 2 min
1616
1717
<div class="mb-0 p-6 bg-[var(--vp-c-bg-soft)] rounded-lg border border-[var(--vp-c-divider)]">
1818
<div class="flex">
@@ -23,7 +23,7 @@ import ChainSelector from '@/components/ChainSelector.vue'
2323

2424
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
2525
<h2 class="text-2xl font-bold mt-0 border-none!">Start Your Web3 Privacy Journey</h2>
26-
<p>And learn how to build Privacy-preserving decentralized applications (dApps) with iExec in this interactive guide.</p>
26+
<p>And learn how to build Privacy-preserving decentralized applications (DApp) with iExec in this interactive guide.</p>
2727
<div class="mt-6 flex items-center gap-4">
2828
<span class="bg-gray-900 text-white px-4 py-2 rounded-full font-medium">☕ 30 minutes journey</span>
2929
<p>Perfect for hackathons 😊</p>

src/get-started/helloWorld/1-overview.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
title: iExec Overview
33
description:
44
Explore how iExec's confidential computing toolkit helps developers build
5-
privacy-preserving dApps. Learn how DataProtector and iApps let users control,
5+
privacy-preserving iApp. Learn how DataProtector and iApp let users control,
66
protect, and monetize sensitive data.
77
---
88

99
# 🧐 iExec Overview
1010

11-
> Reading time 🕒 8 mins
11+
> Reading time 🕒 8 min
1212
1313
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
1414
<h2 class="text-2xl font-bold mt-0 border-none!">Let's start with the basics</h2>
1515
<p>and explore how iExec can help you build Privacy-preserving applications and securely manage sensitive data.</p>
1616
</div>
1717

18-
## 👨‍💻 Building Privacy-preserving dApps with iExec
18+
## 👨‍💻 Building Privacy-preserving iApp with iExec
1919

20-
<p>Imagine you're building a decentralized application (dApp) that needs to <strong> handle sensitive user data</strong>, for example:</p>
20+
<p>Imagine you're building a decentralized application (iApp) that needs to <strong> handle sensitive user data</strong>, for example:</p>
2121
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
2222
<div class="flex flex-col gap-2.5">
2323
<div class="flex items-center gap-2 text-base">
@@ -60,7 +60,7 @@ description:
6060
</div>
6161

6262
<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">
63-
<p class="m-0!">This is where <span class="text-fuchsia-700 font-semibold">iExec</span> comes in! We provide tools to easily add <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">monetization</span> features into your dApp.</p>
63+
<p class="m-0!">This is where <span class="text-fuchsia-700 font-semibold">iExec</span> comes in! We provide tools to easily add <span class="text-fuchsia-700 font-semibold">privacy</span> and <span class="text-fuchsia-700 font-semibold">monetization</span> features into your iApp.</p>
6464
</div>
6565

6666
## 👷 How do we Solve it?
@@ -84,14 +84,14 @@ Computing</a></span> technologies.
8484

8585
iExec combines three fundamental elements that work together seamlessly:
8686

87-
#### 1. Protect Data with our Devtool [DataProtector](/references/dataProtector/getting-started)
87+
#### 1. Protect Data with our DevTool [DataProtector](/references/dataProtector/getting-started)
8888

8989
- Encrypt your sensitive data and store it securely on Arweave or IPFS
9090
- Only you control who can access it and when
9191
- Perfect for private information like research data, business analytics, or
9292
personal records
9393

94-
#### 2. Compute Data with iExec Apps (iApps) Running in Secure Environment
94+
#### 2. Compute Data with iExec Apps (iApp) Running in Secure Environment
9595

9696
- Special applications that can work with protected data
9797
- Run in secure environments (called TEEs) that keep your data private
@@ -115,17 +115,17 @@ inside stays **safe** and **private**.
115115
With a tool called **DataProtector**, your data becomes **protected** and can
116116
only be read and processed inside this secure room.
117117

118-
Special applications called **iApps** (applications built to run in secure
118+
Special applications called **iApp** (applications built to run in secure
119119
environments) can enter the room to work with your data. You stay in **control**
120120
by setting **access rules** that only you can modify about who can access it and
121121
when.
122122

123-
## 🔍 Building your First Privacy-preserving dApp
123+
## 🔍 Building your First Privacy-preserving iApp
124124

125125
Let's meet Bob and Alice to understand how iExec enables Privacy-preserving
126126
applications:
127127

128-
### 1. Meet Bob: the dApp Developer 👨‍💻
128+
### 1. Meet Bob: the iApp Developer 👨‍💻
129129

130130
Bob is building a decentralized application that uses iExec's technology. His
131131
platform consists of:
@@ -135,7 +135,7 @@ platform consists of:
135135
- Thanks to DataProtector, end users can protect their data, manage access, and
136136
process it seamlessly.
137137

138-
### 2. Meet Alice: the dApp User 👩‍💼
138+
### 2. Meet Alice: the iApp User 👩‍💼
139139

140140
When using Bob's platform, Alice can:
141141

@@ -144,7 +144,7 @@ When using Bob's platform, Alice can:
144144
- Authorize specific iExec Apps and persons like Bob to use her data in a secure
145145
environment
146146

147-
Depending on the dApp's use case, Alice could:
147+
Depending on the iApp's use case, Alice could:
148148

149149
- Apply algorithms to her data and get results confidentially
150150
- Share her data with other users privately (and get paid for it)
@@ -166,7 +166,7 @@ And many other use cases...
166166
</div>
167167
<div class="flex items-center gap-3">
168168
<span class="text-xl">📦</span>
169-
<p class="m-0"><strong>iApps (iExec App):</strong> Special applications that can process protected data</p>
169+
<p class="m-0"><strong>iApp (iExec App):</strong> Special applications that can process protected data</p>
170170
</div>
171171
<div class="flex items-center gap-3">
172172
<span class="text-xl">⛓️</span>

src/get-started/helloWorld/2-protectData.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import ProtectData from '@/modules/helloWorld/ProtectData.vue';
1515
1616
<div class="bg-gradient-to-r from-[#fcd15a] to-[#ffad4d] rounded-[6px] px-8 pb-4 text-gray-800 max-w-3xl mx-auto mb-6">
1717
<h2 class="text-2xl font-bold mt-0 border-none!">Time to get practical</h2>
18-
<p>Let's follow Alice as she learns how to protect her data using DataProtector on Bob's dApp, our developer tool for protecting data creation and management.</p>
18+
<p>Let's follow Alice as she learns how to protect her data using DataProtector on Bob's iApp, our developer tool for protecting data creation and management.</p>
1919
</div>
2020

2121
<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">
@@ -26,7 +26,7 @@ import ProtectData from '@/modules/helloWorld/ProtectData.vue';
2626

2727
DataProtector is a developer tool built on top of our technology. It helps
2828
developers easily add data protection, management, and monetization features to
29-
their dApps with these key features:
29+
their DApp with these key features:
3030

3131
- 🔐 **Data Privacy and Security**
3232

@@ -40,7 +40,7 @@ their dApps with these key features:
4040
Allows users to manage access, enabling flexible control and monetization of
4141
data assets.
4242

43-
- 🔌 **Seamless dApp Integration**
43+
- 🔌 **Seamless iApp Integration**
4444

4545
Features an SDK for easy integration into your DApp, enhancing functionality
4646
and user experience.

0 commit comments

Comments
 (0)