fix: add titles and descriptions to documentation files for improved clarity

Le-Caignec · Le-Caignec · commit 9aa78a7ce520 · 2025-08-11T00:06:29.000+02:00
diff --git a/src/build-iapp/iapp-generator.md b/src/build-iapp/iapp-generator.md
@@ -1,3 +1,8 @@
+---
+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.
+---
+
 # 🤖 iApp Generator
 
 **Build privacy-first applications that run in secure TEE environments.** iApp
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,3 +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.
+---
+
 # 🧑‍🏭 Build your iApp
 
 ## 🧰 Initialize your iApp
diff --git a/src/build-iapp/iapp-generator/deserializer.md b/src/build-iapp/iapp-generator/deserializer.md
@@ -1,3 +1,8 @@
+---
+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.
+---
+
 # Deserialize a ProtectedData
 
 If you want to build your own iApp (iExec TEE Dapp), you may need to access
diff --git a/src/build-iapp/iapp-generator/deserializer/getValue.md b/src/build-iapp/iapp-generator/deserializer/getValue.md
@@ -1,3 +1,8 @@
+---
+title: getValue
+description: Method to deserialize a value given a provided type using the IExecDataProtectorDeserializer.
+---
+
 # getValue
 
 Method to deserialize a value given a provided type.
diff --git a/src/build-iapp/iapp-generator/getting-started.md b/src/build-iapp/iapp-generator/getting-started.md
@@ -1,3 +1,8 @@
+---
+title: Getting Started
+description: Learn how to set up and start using the iApp Generator with prerequisites, installation, and first steps.
+---
+
 # 🛠 Getting Started
 
 ## 🕕 Prerequisites
diff --git a/src/manage-data/dataProtector.md b/src/manage-data/dataProtector.md
@@ -1,6 +1,7 @@
 ---
+title: DataProtector
 description:
-  Discover DataProtector, iExec’s secure data management solution. Encrypt,
+  Discover DataProtector, iExec's secure data management solution. Encrypt,
   share, and monetize your data with DataProtector Core and Sharing modules, all
   powered by blockchain technology.
 ---
diff --git a/src/manage-data/dataProtector/advanced/advanced-configuration.md b/src/manage-data/dataProtector/advanced/advanced-configuration.md
@@ -1,4 +1,5 @@
 ---
+title: Advanced Configuration
 description:
   Explore advanced configuration options for the IExecDataProtector constructor
   in the iExec DataProtector SDK. Customize Ethereum contract addresses,
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist.md
@@ -1,4 +1,5 @@
 ---
+title: Apps Whitelist
 description:
   Understand the Apps Whitelist mechanism for consuming protected data in the
   iExec DataProtector Sharing module. Learn about the Trusted Execution
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md
@@ -1,3 +1,8 @@
+---
+title: addAppToAddOnlyAppWhitelist
+description: Method to add an app (iExec TEE dApp) into the AddOnlyAppWhitelist for secure data access control.
+---
+
 # addAppToAddOnlyAppWhitelist
 
 Method to add an app (iExec TEE dApp) into the `AddOnlyAppWhitelist`.
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist.md
@@ -1,3 +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.
+---
+
 # createAddOnlyAppWhitelist
 
 Method to create an `AddOnlyAppWhitelist`. By default, the owner will be the
diff --git a/src/manage-data/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md b/src/manage-data/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md
@@ -1,3 +1,8 @@
+---
+title: getUserAddOnlyAppWhitelist
+description: Method to get AddOnlyAppWhitelist with filtering by user ethereum address for app access control management.
+---
+
 # getUserAddOnlyAppWhitelist
 
 Method to get `AddOnlyAppWhitelist`, you can filter by user ethereum address.
diff --git a/src/manage-data/dataProtector/advanced/dps-smart-contract.md b/src/manage-data/dataProtector/advanced/dps-smart-contract.md
@@ -1,8 +1,9 @@
 ---
+title: DataProtector Sharing Smart Contracts
 description:
   Learn about the DataProtector Sharing smart contract for managing and sharing
   protected data via collections, subscriptions, rentals, and sales. Explore the
-  Solidity code and features in iExec’s implementation.
+  Solidity code and features in iExec's implementation.
 ---
 
 # DataProtector Sharing Smart Contracts
diff --git a/src/manage-data/dataProtector/dataProtectorCore.md b/src/manage-data/dataProtector/dataProtectorCore.md
@@ -1,4 +1,5 @@
 ---
+title: DataProtector Core
 description:
   Learn how DataProtector Core gives developers powerful tools to encrypt data,
   manage ownership with NFTs, and control access using smart contracts and
diff --git a/src/manage-data/dataProtector/dataProtectorCore/getGrantedAccess.md b/src/manage-data/dataProtector/dataProtectorCore/getGrantedAccess.md
@@ -1,6 +1,7 @@
 ---
+title: getGrantedAccess
 description:
-  Retrieve all granted access details for a protected data object with iExec’s
+  Retrieve all granted access details for a protected data object with iExec's
   getGrantedAccess method. Filter access by user, application, or both, and
   manage access with pagination.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorCore/getProtectedData.md b/src/manage-data/dataProtector/dataProtectorCore/getProtectedData.md
@@ -1,4 +1,5 @@
 ---
+title: getProtectedData
 description:
   Retrieve all protected data for a specific owner or schema with the
   getProtectedData method in iExec DataProtector. Easily access encrypted data
diff --git a/src/manage-data/dataProtector/dataProtectorCore/getResultFromCompletedTask.md b/src/manage-data/dataProtector/dataProtectorCore/getResultFromCompletedTask.md
@@ -1,6 +1,7 @@
 ---
+title: getResultFromCompletedTask
 description:
-  Retrieve the result of a completed task with iExec’s
+  Retrieve the result of a completed task with iExec's
   getResultFromCompletedTask method. Easily access task outcomes by providing
   the task ID.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorCore/grantAccess.md b/src/manage-data/dataProtector/dataProtectorCore/grantAccess.md
@@ -1,4 +1,5 @@
 ---
+title: grantAccess
 description:
   Grant secure access to encrypted data with iExec's grantAccess method.
   Authorize specific applications or users to process protected data, with
diff --git a/src/manage-data/dataProtector/dataProtectorCore/processProtectedData.md b/src/manage-data/dataProtector/dataProtectorCore/processProtectedData.md
@@ -1,8 +1,9 @@
 ---
+title: processProtectedData
 description:
-  Process encrypted data securely with iExec’s processProtectedData method. Use
+  Process encrypted data securely with iExec's processProtectedData method. Use
   authorized applications to process protected datasets while maintaining data
-  privacy and security
+  privacy and security.
 ---
 
 # processProtectedData
diff --git a/src/manage-data/dataProtector/dataProtectorCore/protectData.md b/src/manage-data/dataProtector/dataProtectorCore/protectData.md
@@ -1,4 +1,5 @@
 ---
+title: protectData
 description:
   Use the protectData method from iExec DataProtector to encrypt user data
   client-side and ensure full privacy. Easily secure emails, credentials, or
diff --git a/src/manage-data/dataProtector/dataProtectorCore/revokeAllAccess.md b/src/manage-data/dataProtector/dataProtectorCore/revokeAllAccess.md
@@ -1,6 +1,7 @@
 ---
+title: revokeAllAccess
 description:
-  Revoke all or specific access permissions to protected data with iExec’s
+  Revoke all or specific access permissions to protected data with iExec's
   revokeAllAccess method. Efficiently manage data security by removing access
   from users or smart contract.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorCore/revokeOneAccess.md b/src/manage-data/dataProtector/dataProtectorCore/revokeOneAccess.md
@@ -1,6 +1,7 @@
 ---
+title: revokeOneAccess
 description:
-  Revoke specific access permissions to protected data with iExec’s
+  Revoke specific access permissions to protected data with iExec's
   revokeOneAccess method. Manage and remove access granted to users or
   applications through blockchain transactions.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorCore/transferOwnership.md b/src/manage-data/dataProtector/dataProtectorCore/transferOwnership.md
@@ -1,6 +1,7 @@
 ---
+title: transferOwnership
 description:
-  Transfer ownership of protected data to a new owner with iExec’s
+  Transfer ownership of protected data to a new owner with iExec's
   transferOwnership method. Securely update data ownership and automatically
   revoke previous access permissions.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorSharing.md b/src/manage-data/dataProtector/dataProtectorSharing.md
@@ -1,4 +1,5 @@
 ---
+title: DataProtector Sharing
 description:
   Distribute and monetize your protected data effortlessly with DataProtector
   Sharing. Use smart contracts to manage access, rent, or sell data while
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/collection.md b/src/manage-data/dataProtector/dataProtectorSharing/collection.md
@@ -1,6 +1,7 @@
 ---
+title: Data Sharing - Collection Methods
 description:
-  Organize your protected data into collections with iExec’s Data Sharing
+  Organize your protected data into collections with iExec's Data Sharing
   module. Choose distribution options like renting, free access, subscription,
   or selling to control how your data is shared and monetized.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/collection/addToCollection.md b/src/manage-data/dataProtector/dataProtectorSharing/collection/addToCollection.md
@@ -1,4 +1,5 @@
 ---
+title: addToCollection
 description:
   Transfer a protected data to one of your collections in the Data Sharing smart
   contract. The method approves the contract to manage the data and adds it to
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/collection/createCollection.md b/src/manage-data/dataProtector/dataProtectorSharing/collection/createCollection.md
@@ -1,6 +1,7 @@
 ---
+title: createCollection
 description:
-  Create a new NFT collection with iExec’s createCollection method. Organize and
+  Create a new NFT collection with iExec's createCollection method. Organize and
   manage your protected data for seamless distribution and monetization through
   DataProtector Sharing.
 ---
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/collection/removeCollection.md b/src/manage-data/dataProtector/dataProtectorSharing/collection/removeCollection.md
@@ -1,4 +1,5 @@
 ---
+title: removeCollection
 description:
   Remove a collection from the Data Sharing smart contract by burning its
   associated NFT. Transfer the NFT to the zero address and permanently remove
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md b/src/manage-data/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md
@@ -1,4 +1,5 @@
 ---
+title: removeProtectedDataFromCollection
 description:
   Remove a protected data from one of your collections in the Data Sharing smart
   contract. This method transfers the ownership of the protected data back to
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md b/src/manage-data/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md
@@ -1,4 +1,5 @@
 ---
+title: consumeProtectedData
 description:
   Consume protected data in iExec by visualizing or downloading it. This method
   involves generating RSA keys, interacting with iExec's Secret Management
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionOwners.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionOwners.md
@@ -1,3 +1,8 @@
+---
+title: getCollectionOwners
+description: Method to get all collection owners with results ordered by creation timestamp in descending order.
+---
+
 # getCollectionOwners
 
 Method to get all collection owners.
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md
@@ -1,4 +1,5 @@
 ---
+title: getCollectionSubscriptions
 description:
   Fetch all subscriptions for a specific collection or user in iExec. Get
   detailed information about subscription activity based on collection ID.
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md
@@ -1,3 +1,8 @@
+---
+title: getCollectionsByOwner
+description: Method to get all collections for a specific user with filtering and pagination options.
+---
+
 # getCollectionsByOwner
 
 Method to get all collections for a specific user.
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md
@@ -1,4 +1,5 @@
 ---
+title: getProtectedDataInCollections
 description:
   Retrieve protected data from collections in iExec. Each protected data can
   belong to only one collection at a time, with results ordered by creation
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md
@@ -1,7 +1,8 @@
 ---
+title: getProtectedDataPricingParams
 description:
-  Get all distribution parameters for a protected data in iExec. Retrieve
-  detailed pricing information for a specific protected data using its address.
+  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/read/getRentals.md b/src/manage-data/dataProtector/dataProtectorSharing/read/getRentals.md
@@ -1,4 +1,5 @@
 ---
+title: getRentals
 description:
   Retrieve all rentals for a specific protected data or user in iExec. Access
   detailed rental information based on the protected data address.
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/renting.md b/src/manage-data/dataProtector/dataProtectorSharing/renting.md
@@ -1,4 +1,5 @@
 ---
+title: Data Sharing - Renting
 description:
   Renting options for distributing protected data allow consumers to access data
   for a set price and duration. The Data Sharing smart contract ensures renter
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md b/src/manage-data/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md
@@ -1,4 +1,5 @@
 ---
+title: removeProtectedDataFromRenting
 description:
   The removeProtectedDataFromRenting method allows the collection owner to
   remove a protected data item from being rented. Active rentals will still be
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/renting/rentProtectedData.md b/src/manage-data/dataProtector/dataProtectorSharing/renting/rentProtectedData.md
@@ -1,4 +1,5 @@
 ---
+title: rentProtectedData
 description:
   The rentProtectedData method allows you to rent a protected data item by
   specifying the price and duration. If the parameters don't match the current
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams.md b/src/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams.md
@@ -1,4 +1,5 @@
 ---
+title: setProtectedDataRentingParams
 description:
   The setProtectedDataRentingParams method allows you to set or update the
   renting parameters (price and duration) for a protected data item. If the data
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md b/src/manage-data/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md
@@ -1,4 +1,5 @@
 ---
+title: setProtectedDataToRenting
 description:
   The setProtectedDataToRenting method allows a protected data item to be listed
   for rent. This method sets the price and duration for future rentals. If the
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling.md b/src/manage-data/dataProtector/dataProtectorSharing/selling.md
@@ -1,3 +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.
+---
+
 # Data Sharing - Selling
 
 The owner of protected data may list the data for sale. Upon completion of a
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling/buyProtectedData.md b/src/manage-data/dataProtector/dataProtectorSharing/selling/buyProtectedData.md
@@ -1,4 +1,5 @@
 ---
+title: buyProtectedData
 description:
   Allows a user to purchase protected data that is listed for sale. Upon
   successful purchase, the buyer gains full ownership and can distribute or keep
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md b/src/manage-data/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md
@@ -1,3 +1,8 @@
+---
+title: removeProtectedDataForSale
+description: Method to remove a protected data from sale listing, preventing further purchase transactions.
+---
+
 # removeProtectedDataForSale
 
 Method to remove a protected data for sale.
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md b/src/manage-data/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md
@@ -1,4 +1,5 @@
 ---
+title: setProtectedDataForSale
 description:
   Allows a data owner to list their protected data for sale by setting a price.
   Upon successful sale, ownership is transferred to the buyer, who can choose
diff --git a/src/manage-data/dataProtector/dataProtectorSharing/subscription.md b/src/manage-data/dataProtector/dataProtectorSharing/subscription.md
@@ -1,4 +1,5 @@
 ---
+title: Data Sharing - Subscription
 description:
   Learn how to manage subscription agreements for protected data on the iExec
   platform. Understand subscription pricing and duration, along with options for
diff --git a/src/manage-data/dataProtector/migrate-from-v1.md b/src/manage-data/dataProtector/migrate-from-v1.md
@@ -1,4 +1,5 @@
 ---
+title: Migrate from V1 to V2
 description:
   Follow this guide to migrate your DataProtector project from v1 to v2beta with
   the latest npm package
diff --git a/src/manage-data/dataProtector/types.md b/src/manage-data/dataProtector/types.md
@@ -1,3 +1,8 @@
+---
+title: Types
+description: Complete reference for DataProtector types including GrantedAccess, ProtectedData, Collection, and other essential data structures.
+---
+
 # Types
 
 Types in DataProtector.
