Merge remote-tracking branch 'origin/main' into feature/confidential-computing

Author: Le-Caignec

.github/styles/config/vocabularies/Technical/accept.txt

@@ -0,0 +1,192 @@
+# Technical terms for iExec documentation
+
+# Function Names
+protectData
+grantAccess
+revokeAllAccess
+revokeOneAccess
+transferOwnership
+createCollection
+removeCollection
+removeProtectedDataFromCollection
+sendEmail
+sendTelegram
+getValue
+deserializer
+deserialize
+consumeProtectedData
+rentProtectedData
+subscribeToCollection
+buyProtectedData
+setProtectedDataForSale
+setProtectedDataToRenting
+setProtectedDataToSubscription
+setProtectedDataRentingParams
+setSubscriptionParams
+addToCollection
+removeProtectedDataFromCollection
+removeProtectedDataFromRenting
+removeProtectedDataForSale
+addAppToAddOnlyAppWhitelist
+createAddOnlyAppWhitelist
+getUserAddOnlyAppWhitelist
+getGrantedAccess
+getProtectedData
+getResultFromCompletedTask
+getCollectionOwners
+getCollectionsByOwner
+getCollectionSubscriptions
+getProtectedDataInCollections
+getProtectedDataPricingParams
+getRentals
+fetchMyContacts
+fetchUserContacts
+unpublish
+
+# Function Parameters
+authorizedApp
+authorizedUser
+grantedAccess
+collectionId
+appsWhitelist
+userWhitelist
+useVoucher
+voucherAddress
+voucherOwner
+subscriberAddress
+renterAddress
+apporder
+datasetorder
+workerpoolorder
+requestorder
+requesters
+workerpools
+apporders
+appmaxprice
+datasetmaxprice
+workerpoolmaxprice
+apprestrict
+requesterrestrict
+workerpoolrestrict
+datasetprice
+taskId
+dealId
+userAddress
+resultHash
+resultSeal
+enclaveSign
+workerpoolSign
+inputFiles
+zipFile
+encryptionKey
+multiaddr
+ipfsNode
+ipfsGateway
+emailSubject
+emailContent
+contentType
+senderName
+telegramContent
+//TODO: check
+param
+params
+args
+environnement
+pageSize
+subgraphUrl
+subgraph
+iexecOptions
+uploadMode
+allowDebug
+requiredSchema
+keypair
+collectionOwner
+isRentable
+isDistributed
+NFTs
+creationTimestamp
+transactionHash
+txHash
+boolean
+bigint
+newOwner
+maxPrice
+workerpoolorders
+
+# iExec/Web3 Terms
+iExec
+CPUs
+LLMs
+Agentic
+DApp
+DApps
+blockchain
+ethereum
+intel
+nano
+workerpool
+Workerpool
+protectedData
+dataProtector
+DataProtector
+iApp
+sconification
+middleware
+oracle
+MREnclave
+Gramine
+//TODO: check
+permissioning
+Permissioning
+arithmetics
+webservers
+Javascript
+Dockerizable
+Dockerize
+Dockerhub
+dockerized
+keystore
+Webpack
+json
+polyfills
+Buildx
+hardcoding
+npm
+Arweave
+cryptocurrency
+cryptocurrencies
+crypto
+onchain
+offchain
+//TODO: check
+mainchain
+Sidechain
+Bellecour
+Mainnet
+Testnet
+Metamask
+Binance
+Coinbase
+Uniswap
+Szabo
+presale
+presigned
+untrusted
+dev
+cryptocurrecny
+Unmatching
+incentivized
+Whitepaper
+deserialization
+enclaveChallenge
+Borsh
+Arbitrum
+Stargate
+Github
+subgraphs
+hackathons
+tokenization
+chipset
+auditable
+Composable
+Activable

.github/styles/config/vocabularies/Technical/reject.txt

@@ -0,0 +1,2 @@
+# Terms to reject - currently empty
+# Add terms here that should always be flagged as errors

.github/workflows/vale.yml

@@ -0,0 +1,27 @@
+name: Documentation Quality
+
+on:
+  pull_request:
+
+jobs:
+  vale:
+    name: Vale Documentation Quality Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run Vale
+        # Vale runs spell checking and basic grammar validation
+        # - reporter: github-pr-check provides concise feedback in PR comments
+        # - fail_on_error: false prevents workflow failures on minor issues
+        # - filter_mode: added only checks files changed in the PR
+        # - vale_flags: sets minimum alert level to suggestions only
+        uses: errata-ai/[email protected]
+        with:
+          files: src/
+          reporter: github-pr-check
+          fail_on_error: false
+          filter_mode: added
+          vale_flags: '--minAlertLevel=suggestion'

.gitignore

@@ -12,3 +12,8 @@ components.d.ts
 
 #mac
 .DS_Store
+
+#vale
+.github/styles/*
+!.github/styles/config/vocabularies/
+vale-report.txt

.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = .github/styles
+MinAlertLevel = suggestion
+Packages = Google
+
+# Define the Technical vocabulary for custom terminology
+Vocab = Technical
+
+[formats]
+md = markdown
+
+[*.md]
+BasedOnStyles = Vale, Google
+IgnorePatterns = README.md

.vitepress/config.ts

@@ -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',

.vitepress/sidebar.ts

@@ -56,20 +56,20 @@ export function getSidebar() {
         text: 'iExec OVERVIEW',
         items: [
           {
-            text: '❓ What is iExec ?',
+            text: 'What is iExec ?',
             link: '/get-started/overview/what-is-iexec',
           },
           {
-            text: '❓  What is Protected Data ?',
-            link: '/get-started/overview/what-is-protected-data',
+            text: 'Protected Data',
+            link: '/get-started/overview/protected-data',
           },
           {
-            text: '❓ What is an iApp ?',
-            link: '/get-started/overview/what-is-iapp',
+            text: 'iApp',
+            link: '/get-started/overview/iapp',
           },
           {
-            text: '❓ What is a Workerpool ?',
-            link: '/get-started/overview/what-is-workerpool',
+            text: 'Workerpool',
+            link: '/get-started/overview/workerpool',
           },
           {
             text: '🪙 RLC Token',
@@ -110,15 +110,15 @@ export function getSidebar() {
             link: '/get-started/protocol/proof-of-contribution',
           },
           {
-            text: '💸 Pay Per Task Model',
+            text: 'Pay Per Task Model',
             link: '/get-started/protocol/pay-per-task',
           },
           {
-            text: 'iExec DOracle',
-            link: '/get-started/protocol/iexec-doracle',
+            text: 'Oracle',
+            link: '/get-started/protocol/oracle',
           },
           {
-            text: '⚙️ Workers & Workerpools',
+            text: 'Workers & Workerpools',
             collapsed: true,
             items: [
               {
@@ -178,8 +178,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',
@@ -190,10 +194,6 @@ export function getSidebar() {
             link: '/guides/build-iapp/inputs-and-outputs',
           },
 
-          {
-            text: 'How to Get and Decrypt Results',
-            link: '/guides/build-iapp/how-to-get-and-decrypt-results',
-          },
           {
             text: 'Debugging',
             link: '/guides/build-iapp/debugging',
@@ -249,43 +249,17 @@ export function getSidebar() {
             text: '🚀 Getting Started',
             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: 'Add Inputs to the Execution',
-            link: '/guides/use-iapp/add-inputs-to-execution',
-          },
           {
             text: 'How to Pay the Executions',
             link: '/guides/use-iapp/how-to-pay-executions',
           },
           {
-            text: '💰 How to Pay',
-            collapsed: true,
-            items: [
-              {
-                text: 'How to Pay for Web3Mail',
-                link: '/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail',
-              },
-              {
-                text: 'How to Pay for Web3Telegram',
-                link: '/guides/use-iapp/how-to-pay/how-to-pay-for-web3telegram',
-              },
-              {
-                text: 'Pricing Considerations',
-                link: '/guides/use-iapp/how-to-pay/pricing-considerations',
-              },
-              {
-                text: 'Voucher',
-                link: '/guides/use-iapp/how-to-pay/voucher',
-              },
-            ],
+            text: 'Run iApp with ProtectedData',
+            link: '/guides/use-iapp/run-iapp-with-ProtectedData',
+          },
+          {
+            text: 'Run iApp without ProtectedData',
+            link: '/guides/use-iapp/run-iapp-without-ProtectedData',
           },
         ],
       },