fix: format descriptions in documentation files for improved readability

Le-Caignec · Le-Caignec · commit 3e3944cb61dd · 2025-08-11T00:10:22.000+02:00
diff --git a/src/build-iapp/iapp-generator.md b/src/build-iapp/iapp-generator.md
@@ -1,6 +1,9 @@
 ---
 title: iApp Generator
-description: Build privacy-first applications that run in secure TEE environments. Your complete toolkit for creating, testing, and deploying confidential iApps on the iExec network.
+description:
+  Build privacy-first applications that run in secure TEE environments. Your
+  complete toolkit for creating, testing, and deploying confidential iApps on
+  the iExec network.
 ---
 
 # 🤖 iApp Generator
diff --git a/src/build-iapp/iapp-generator/building-your-iexec-app.md b/src/build-iapp/iapp-generator/building-your-iexec-app.md
@@ -1,6 +1,8 @@
 ---
 title: Build Your iApp
-description: Learn how to initialize, configure, and build your iExec application using the iApp Generator CLI with step-by-step guidance.
+description:
+  Learn how to initialize, configure, and build your iExec application using the
+  iApp Generator CLI with step-by-step guidance.
 ---
 
 # 🧑‍🏭 Build your iApp
diff --git a/src/build-iapp/iapp-generator/deserializer.md b/src/build-iapp/iapp-generator/deserializer.md
@@ -1,6 +1,9 @@
 ---
 title: Deserialize a ProtectedData
-description: Learn how to deserialize protected data in your iApp using the @iexec/dataprotector-deserializer utility package for accessing authorized data.
+description:
+  Learn how to deserialize protected data in your iApp using the
+  @iexec/dataprotector-deserializer utility package for accessing authorized
+  data.
 ---
 
 # Deserialize a ProtectedData
diff --git a/src/build-iapp/iapp-generator/deserializer/getValue.md b/src/build-iapp/iapp-generator/deserializer/getValue.md
@@ -1,6 +1,8 @@
 ---
 title: getValue
-description: Method to deserialize a value given a provided type using the IExecDataProtectorDeserializer.
+description:
+  Method to deserialize a value given a provided type using the
+  IExecDataProtectorDeserializer.
 ---
 
 # getValue
diff --git a/src/build-iapp/iapp-generator/getting-started.md b/src/build-iapp/iapp-generator/getting-started.md
@@ -1,6 +1,8 @@
 ---
 title: Getting Started
-description: Learn how to set up and start using the iApp Generator with prerequisites, installation, and first steps.
+description:
+  Learn how to set up and start using the iApp Generator with prerequisites,
+  installation, and first steps.
 ---
 
 # 🛠 Getting Started
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md
@@ -1,6 +1,8 @@
 ---
 title: addAppToAddOnlyAppWhitelist
-description: Method to add an app (iExec TEE dApp) into the AddOnlyAppWhitelist for secure data access control.
+description:
+  Method to add an app (iExec TEE dApp) into the AddOnlyAppWhitelist for secure
+  data access control.
 ---
 
 # addAppToAddOnlyAppWhitelist
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist.md
@@ -1,6 +1,8 @@
 ---
 title: createAddOnlyAppWhitelist
-description: Method to create an AddOnlyAppWhitelist for controlling app access. The caller becomes the owner by default, with transferable ownership as an ERC721.
+description:
+  Method to create an AddOnlyAppWhitelist for controlling app access. The caller
+  becomes the owner by default, with transferable ownership as an ERC721.
 ---
 
 # createAddOnlyAppWhitelist
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md
@@ -1,6 +1,8 @@
 ---
 title: getUserAddOnlyAppWhitelist
-description: Method to get AddOnlyAppWhitelist with filtering by user ethereum address for app access control management.
+description:
+  Method to get AddOnlyAppWhitelist with filtering by user ethereum address for
+  app access control management.
 ---
 
 # getUserAddOnlyAppWhitelist
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionOwners.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionOwners.md
@@ -1,6 +1,8 @@
 ---
 title: getCollectionOwners
-description: Method to get all collection owners with results ordered by creation timestamp in descending order.
+description:
+  Method to get all collection owners with results ordered by creation timestamp
+  in descending order.
 ---
 
 # getCollectionOwners
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md
@@ -1,6 +1,8 @@
 ---
 title: getCollectionsByOwner
-description: Method to get all collections for a specific user with filtering and pagination options.
+description:
+  Method to get all collections for a specific user with filtering and
+  pagination options.
 ---
 
 # getCollectionsByOwner
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md
@@ -1,8 +1,9 @@
 ---
 title: getProtectedDataPricingParams
 description:
-  Get pricing parameters for renting a specific protected data in iExec. Retrieve
-  rental price and duration to determine the cost and terms for data access.
+  Get pricing parameters for renting a specific protected data in iExec.
+  Retrieve rental price and duration to determine the cost and terms for data
+  access.
 ---
 
 # getProtectedDataPricingParams
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling.md b/src/manage-data/dataProtector/dataProtectorSharing/selling.md
@@ -1,6 +1,8 @@
 ---
 title: Data Sharing - Selling
-description: Learn how to list protected data for sale, transfer ownership permanently through blockchain transactions, and manage data listing operations.
+description:
+  Learn how to list protected data for sale, transfer ownership permanently
+  through blockchain transactions, and manage data listing operations.
 ---
 
 # Data Sharing - Selling
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md b/src/manage-data/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md
@@ -1,6 +1,8 @@
 ---
 title: removeProtectedDataForSale
-description: Method to remove a protected data from sale listing, preventing further purchase transactions.
+description:
+  Method to remove a protected data from sale listing, preventing further
+  purchase transactions.
 ---
 
 # removeProtectedDataForSale
diff --git a/src/manage-data/dataProtector/types.md b/src/manage-data/dataProtector/types.md
@@ -1,6 +1,8 @@
 ---
 title: Types
-description: Complete reference for DataProtector types including GrantedAccess, ProtectedData, Collection, and other essential data structures.
+description:
+  Complete reference for DataProtector types including GrantedAccess,
+  ProtectedData, Collection, and other essential data structures.
 ---
 
 # Types
diff --git a/src/overview/helloWorld/2-protectData.md b/src/overview/helloWorld/2-protectData.md
@@ -1,6 +1,8 @@
 ---
 title: Let's Protect Data
-description: Learn how to protect your data using iExec's DataProtector SDK in this hands-on tutorial step.
+description:
+  Learn how to protect your data using iExec's DataProtector SDK in this
+  hands-on tutorial step.
 ---
 
 <script setup>
diff --git a/src/overview/helloWorld/3-buildIApp.md b/src/overview/helloWorld/3-buildIApp.md
@@ -1,6 +1,8 @@
 ---
 title: Build and Deploy Your First iApp
-description: Learn how to build and deploy your first iExec application (iApp) for processing protected data in this comprehensive tutorial.
+description:
+  Learn how to build and deploy your first iExec application (iApp) for
+  processing protected data in this comprehensive tutorial.
 ---
 
 # 🛠️ Build and Deploy your First iApp
diff --git a/src/overview/helloWorld/4-manageDataAccess.md b/src/overview/helloWorld/4-manageDataAccess.md
@@ -1,6 +1,8 @@
 ---
 title: Manage Data Access
-description: Learn how to grant and manage access to protected data using iExec's DataProtector SDK in this tutorial step.
+description:
+  Learn how to grant and manage access to protected data using iExec's
+  DataProtector SDK in this tutorial step.
 ---
 
 <script setup>
diff --git a/src/overview/helloWorld/5-bonusChapter.md b/src/overview/helloWorld/5-bonusChapter.md
@@ -1,6 +1,8 @@
 ---
 title: Bonus Chapter
-description: Explore additional features and advanced concepts in this bonus chapter of the Hello World tutorial series.
+description:
+  Explore additional features and advanced concepts in this bonus chapter of the
+  Hello World tutorial series.
 ---
 
 <script setup>
diff --git a/src/overview/quick-start.md b/src/overview/quick-start.md
@@ -1,6 +1,8 @@
 ---
 title: Quick Start
-description: Get started quickly with iExec's privacy-preserving technologies and explore our project starters and interactive sandboxes
+description:
+  Get started quickly with iExec's privacy-preserving technologies and explore
+  our project starters and interactive sandboxes
 ---
 
 # Quick Start
diff --git a/src/overview/use-cases.md b/src/overview/use-cases.md
@@ -1,6 +1,8 @@
 ---
 title: Use Cases
-description: Explore real-world applications and demo showcases of iExec's privacy-preserving technologies in action
+description:
+  Explore real-world applications and demo showcases of iExec's
+  privacy-preserving technologies in action
 ---
 
 # Use Cases Showcase
diff --git a/src/protocol/workers.md b/src/protocol/workers.md
@@ -1,6 +1,8 @@
 ---
 title: Workers and Workerpools
-description: Understanding the compute infrastructure of iExec and how workers and workerpools function
+description:
+  Understanding the compute infrastructure of iExec and how workers and
+  workerpools function
 ---
 
 # ⚙️ Workers & Workerpools
diff --git a/src/use-iapp/getting-started.md b/src/use-iapp/getting-started.md
@@ -1,6 +1,7 @@
 ---
 title: Getting Started with iApps
-description: Your first steps to discover and execute existing iApps on the iExec platform
+description:
+  Your first steps to discover and execute existing iApps on the iExec platform
 ---
 
 # 🚀 Getting Started
diff --git a/src/use-iapp/how-to-pay/how-to-pay-for-web3mail.md b/src/use-iapp/how-to-pay/how-to-pay-for-web3mail.md
@@ -1,6 +1,8 @@
 ---
 title: How to Pay for Web3Mail
-description: Learn how to pay for Web3Mail's confidential computing power using vouchers and xLC for secure, blockchain-based email communication.
+description:
+  Learn how to pay for Web3Mail's confidential computing power using vouchers
+  and xLC for secure, blockchain-based email communication.
 ---
 
 # How to Pay for Web3Mail
diff --git a/src/use-iapp/introduction.md b/src/use-iapp/introduction.md
@@ -1,6 +1,8 @@
 ---
 title: Introduction to Using iApps
-description: Learn how to discover, execute, and interact with iExec applications for privacy-preserving computation
+description:
+  Learn how to discover, execute, and interact with iExec applications for
+  privacy-preserving computation
 ---
 
 # 📝 Introduction
