diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 7fa5426a..9786f80f 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -12,8 +12,8 @@ import { // https://vitepress.dev/reference/site-config export default defineConfig({ - title: 'iExec tools', - description: 'iExec documentation for dev tools', + title: 'iExec Documentation Draft', + description: 'iExec documentation draft - rebuild in progress', // Remove the trailing .html from URLs. Also needs the same option in vercel.json cleanUrls: true, lastUpdated: true, diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index a34d4691..a8fc9d19 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -35,410 +35,526 @@ export function getSidebar() { ], }, { - text: '📽  Use Case Demo', + text: '📋  Use Cases', + link: '/overview/use-cases', collapsed: true, - link: '/overview/use-case-demo', items: [ { - text: 'Content Creator', - link: '/overview/use-case-demo/content-creator', - }, - { - text: 'Web3 Messaging', - link: '/overview/use-case-demo/web3messaging', + text: 'Use Case Demos', + link: '/overview/use-case-demo', + collapsed: true, + items: [ + { + text: 'Content Creator', + link: '/overview/use-case-demo/content-creator', + }, + { + text: 'Web3 Messaging', + link: '/overview/use-case-demo/web3messaging', + }, + ], }, ], }, - // { - // text: '💰  Pricing Considerations', - // link: '/overview/pricing-considerations', - // }, - { - text: '🔧  How to Pay for Web3mail', - link: '/overview/how-to-pay-for-web3mail', - }, - ], - }, - { - text: '🤖  iAppGenerator', - link: '/tools/iapp-generator', - collapsed: false, - items: [ { - text: 'Getting Started', - link: '/tools/iapp-generator/getting-started', + text: '🤖  Use the docs in your AI', + link: '/overview/ai-integration', }, { - text: 'Building Your iApp', - link: '/tools/iapp-generator/building-your-iexec-app', + text: '🆘  Contact Us', + link: '/help/contact-us', }, ], }, { - text: '🔐  DataProtector beta', - link: '/tools/dataProtector', - collapsed: false, + text: 'PROTECT AND MANAGE DATA', items: [ { - text: 'Getting Started', - link: '/tools/dataProtector/getting-started', + text: '❓  What Is Protected Data?', + link: '/tools/dataProtector/what-is-protected-data', }, { - text: 'DataProtector Core', - link: '/tools/dataProtector/dataProtectorCore', - collapsed: true, - items: [ - { - text: 'protectData', - link: '/tools/dataProtector/dataProtectorCore/protectData', - }, - { - text: 'getProtectedData', - link: '/tools/dataProtector/dataProtectorCore/getProtectedData', - }, - { - text: 'transferOwnership', - link: '/tools/dataProtector/dataProtectorCore/transferOwnership', - }, - { - text: 'grantAccess', - link: '/tools/dataProtector/dataProtectorCore/grantAccess', - }, - { - text: 'getGrantedAccess', - link: '/tools/dataProtector/dataProtectorCore/getGrantedAccess', - }, - { - text: 'revokeOneAccess', - link: '/tools/dataProtector/dataProtectorCore/revokeOneAccess', - }, - { - text: 'revokeAllAccess', - link: '/tools/dataProtector/dataProtectorCore/revokeAllAccess', - }, - { - text: 'processProtectedData', - link: '/tools/dataProtector/dataProtectorCore/processProtectedData', - }, - { - text: 'getResultFromCompletedTask', - link: '/tools/dataProtector/dataProtectorCore/getResultFromCompletedTask', - }, - ], + text: '📖  Guides', + link: '/tools/dataProtector/guides', }, { - text: 'DataProtector Sharing', - link: '/tools/dataProtector/dataProtectorSharing', + text: '🔐  DataProtector beta', + link: '/tools/dataProtector', collapsed: true, items: [ { - text: 'Collection', - link: '/tools/dataProtector/dataProtectorSharing/collection', - collapsed: true, - items: [ - { - text: 'createCollection', - link: '/tools/dataProtector/dataProtectorSharing/collection/createCollection', - }, - { - text: 'removeCollection', - link: '/tools/dataProtector/dataProtectorSharing/collection/removeCollection', - }, - { - text: 'addToCollection', - link: '/tools/dataProtector/dataProtectorSharing/collection/addToCollection', - }, - { - text: 'removeProtectedDataFromCollection', - link: '/tools/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection', - }, - ], + text: 'Getting Started', + link: '/tools/dataProtector/getting-started', }, { - text: 'Renting', - link: '/tools/dataProtector/dataProtectorSharing/renting', + text: 'DataProtector Core', + link: '/tools/dataProtector/dataProtectorCore', collapsed: true, items: [ { - text: 'setProtectedDataToRenting', - link: '/tools/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting', - }, - { - text: 'setProtectedDataRentingParams', - link: '/tools/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams', + text: 'protectData', + link: '/tools/dataProtector/dataProtectorCore/protectData', }, { - text: 'rentProtectedData', - link: '/tools/dataProtector/dataProtectorSharing/renting/rentProtectedData', + text: 'getProtectedData', + link: '/tools/dataProtector/dataProtectorCore/getProtectedData', }, { - text: 'removeProtectedDataFromRenting', - link: '/tools/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting', + text: 'transferOwnership', + link: '/tools/dataProtector/dataProtectorCore/transferOwnership', }, - ], - }, - { - text: 'Selling', - link: '/tools/dataProtector/dataProtectorSharing/selling', - collapsed: true, - items: [ { - text: 'setProtectedDataForSale', - link: '/tools/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale', + text: 'grantAccess', + link: '/tools/dataProtector/dataProtectorCore/grantAccess', }, { - text: 'buyProtectedData', - link: '/tools/dataProtector/dataProtectorSharing/selling/buyProtectedData', - }, - { - text: 'removeProtectedDataForSale', - link: '/tools/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale', - }, - ], - }, - { - text: 'Subscription', - link: '/tools/dataProtector/dataProtectorSharing/subscription', - collapsed: true, - items: [ - { - text: 'setProtectedDataToSubscription', - link: '/tools/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription', + text: 'getGrantedAccess', + link: '/tools/dataProtector/dataProtectorCore/getGrantedAccess', }, { - text: 'setSubscriptionParams', - link: '/tools/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams', + text: 'revokeOneAccess', + link: '/tools/dataProtector/dataProtectorCore/revokeOneAccess', }, { - text: 'subscribeToCollection', - link: '/tools/dataProtector/dataProtectorSharing/subscription/subscribeToCollection', + text: 'revokeAllAccess', + link: '/tools/dataProtector/dataProtectorCore/revokeAllAccess', }, { - text: 'removeProtectedDataFromSubscription', - link: '/tools/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription', + text: 'processProtectedData', + link: '/tools/dataProtector/dataProtectorCore/processProtectedData', }, - ], - }, - { - text: 'Consume', - collapsed: true, - items: [ { - text: 'consumeProtectedData', - link: '/tools/dataProtector/dataProtectorSharing/consume/consumeProtectedData', + text: 'getResultFromCompletedTask', + link: '/tools/dataProtector/dataProtectorCore/getResultFromCompletedTask', }, ], }, { - text: 'Read data', + text: 'DataProtector Sharing', + link: '/tools/dataProtector/dataProtectorSharing', collapsed: true, items: [ { - text: 'getProtectedDataInCollections', - link: '/tools/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections', + text: 'Collection', + link: '/tools/dataProtector/dataProtectorSharing/collection', + collapsed: true, + items: [ + { + text: 'createCollection', + link: '/tools/dataProtector/dataProtectorSharing/collection/createCollection', + }, + { + text: 'removeCollection', + link: '/tools/dataProtector/dataProtectorSharing/collection/removeCollection', + }, + { + text: 'addToCollection', + link: '/tools/dataProtector/dataProtectorSharing/collection/addToCollection', + }, + { + text: 'removeProtectedDataFromCollection', + link: '/tools/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection', + }, + ], }, { - text: 'getProtectedDataPricingParams', - link: '/tools/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams', + text: 'Renting', + link: '/tools/dataProtector/dataProtectorSharing/renting', + collapsed: true, + items: [ + { + text: 'setProtectedDataToRenting', + link: '/tools/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting', + }, + { + text: 'setProtectedDataRentingParams', + link: '/tools/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams', + }, + { + text: 'rentProtectedData', + link: '/tools/dataProtector/dataProtectorSharing/renting/rentProtectedData', + }, + { + text: 'removeProtectedDataFromRenting', + link: '/tools/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting', + }, + ], }, { - text: 'getCollectionOwners', - link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionOwners', + text: 'Selling', + link: '/tools/dataProtector/dataProtectorSharing/selling', + collapsed: true, + items: [ + { + text: 'setProtectedDataForSale', + link: '/tools/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale', + }, + { + text: 'buyProtectedData', + link: '/tools/dataProtector/dataProtectorSharing/selling/buyProtectedData', + }, + { + text: 'removeProtectedDataForSale', + link: '/tools/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale', + }, + ], }, { - text: 'getCollectionsByOwner', - link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionsByOwner', + text: 'Subscription', + link: '/tools/dataProtector/dataProtectorSharing/subscription', + collapsed: true, + items: [ + { + text: 'setProtectedDataToSubscription', + link: '/tools/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription', + }, + { + text: 'setSubscriptionParams', + link: '/tools/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams', + }, + { + text: 'subscribeToCollection', + link: '/tools/dataProtector/dataProtectorSharing/subscription/subscribeToCollection', + }, + { + text: 'removeProtectedDataFromSubscription', + link: '/tools/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription', + }, + ], }, { - text: 'getCollectionSubscriptions', - link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions', + text: 'Consume', + collapsed: true, + items: [ + { + text: 'consumeProtectedData', + link: '/tools/dataProtector/dataProtectorSharing/consume/consumeProtectedData', + }, + ], }, { - text: 'getRentals', - link: '/tools/dataProtector/dataProtectorSharing/read/getRentals', + text: 'Read data', + collapsed: true, + items: [ + { + text: 'getProtectedDataInCollections', + link: '/tools/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections', + }, + { + text: 'getProtectedDataPricingParams', + link: '/tools/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams', + }, + { + text: 'getCollectionOwners', + link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionOwners', + }, + { + text: 'getCollectionsByOwner', + link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionsByOwner', + }, + { + text: 'getCollectionSubscriptions', + link: '/tools/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions', + }, + { + text: 'getRentals', + link: '/tools/dataProtector/dataProtectorSharing/read/getRentals', + }, + ], }, ], }, - ], - }, - { - text: 'Types', - link: '/tools/dataProtector/types', - }, - { - text: 'Advanced', - collapsed: true, - items: [ { - text: 'Advanced Configuration', - link: '/tools/dataProtector/advanced/advanced-configuration', + text: 'Types', + link: '/tools/dataProtector/types', }, { - text: 'Sharing smart contract', - link: '/tools/dataProtector/advanced/dps-smart-contract', - }, - { - text: 'Apps whitelist', - link: '/tools/dataProtector/advanced/apps-whitelist', + text: 'Advanced', collapsed: true, items: [ { - text: 'createAddOnlyAppWhitelist', - link: '/tools/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist', + text: 'Advanced Configuration', + link: '/tools/dataProtector/advanced/advanced-configuration', }, { - text: 'addAppToAddOnlyAppWhitelist', - link: '/tools/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist', + text: 'Sharing smart contract', + link: '/tools/dataProtector/advanced/dps-smart-contract', }, { - text: 'getUserAddOnlyAppWhitelist', - link: '/tools/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist', + text: 'Apps whitelist', + link: '/tools/dataProtector/advanced/apps-whitelist', + collapsed: true, + items: [ + { + text: 'createAddOnlyAppWhitelist', + link: '/tools/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist', + }, + { + text: 'addAppToAddOnlyAppWhitelist', + link: '/tools/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist', + }, + { + text: 'getUserAddOnlyAppWhitelist', + link: '/tools/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist', + }, + ], }, - ], - }, - { - text: 'iApp', - link: '/tools/dataProtector/advanced/iApp', - collapsed: true, - items: [ { - text: 'DataProtector Deserializer', - link: '/tools/dataProtector/advanced/iApp/deserializer', + text: 'iApp', + link: '/tools/dataProtector/advanced/iApp', collapsed: true, items: [ { - text: 'getValue', - link: '/tools/dataProtector/advanced/iApp/deserializer/getValue', + text: 'DataProtector Deserializer', + link: '/tools/dataProtector/advanced/iApp/deserializer', + collapsed: true, + items: [ + { + text: 'getValue', + link: '/tools/dataProtector/advanced/iApp/deserializer/getValue', + }, + ], }, ], }, ], }, + { + text: 'Migrate from v1 to v2', + link: '/tools/dataProtector/migrate-from-v1', + }, ], }, - { - text: 'Migrate from v1 to v2', - link: '/tools/dataProtector/migrate-from-v1', - }, ], }, { - text: '✉  Web3mail', - link: '/tools/web3mail', - collapsed: false, + text: 'BUILD YOUR iAPP', items: [ { - text: 'Getting Started', - link: '/tools/web3mail/getting-started', + text: '❓  What Is an iApp?', + link: '/tools/iapp-generator/what-is-iapp', + }, + { + text: '📖  Guides', + collapsed: true, + items: [ + { + text: 'Manage Your iApps', + link: '/tools/iapp-generator/manage-iapps', + }, + { + text: 'Debug Your iApp', + link: '/tools/iapp-generator/debug-iapp', + }, + { + text: 'What Is TDX [EXPERIMENTAL]', + link: '/tools/iapp-generator/tdx-guide', + }, + { + text: 'AI Frameworks', + link: '/tools/iapp-generator/ai-frameworks', + }, + ], }, { - text: 'Methods', + text: '🤖  iApp Generator', + link: '/tools/iapp-generator', collapsed: true, items: [ { - text: 'fetchMyContacts', - link: '/tools/web3mail/methods/fetchMyContacts', + text: 'Getting Started', + link: '/tools/iapp-generator/getting-started', }, { - text: 'fetchUserContacts', - link: '/tools/web3mail/methods/fetchUserContacts', + text: 'Building Your iApp', + link: '/tools/iapp-generator/building-your-iexec-app', }, { - text: 'sendEmail', - link: '/tools/web3mail/methods/sendEmail', + text: 'Advanced Creation', + link: '/tools/iapp-generator/advanced-creation', }, ], }, { - text: 'Advanced Configuration', - link: '/tools/web3mail/advanced-configuration', + text: '🔧  Protocol-Level Guides', + link: '/tools/iapp-generator/protocol-level-guides', }, - // { - // text: "Types", - // link: "/tools/web3mail/types", - // } ], }, { - text: '💬  Web3telegram alpha', - link: '/tools/web3telegram', - collapsed: false, + text: 'USE AN iAPP', items: [ { - text: 'Getting Started', - link: '/tools/web3telegram/getting-started', + text: '📝  Introduction', + link: '/use-iapp/introduction', + }, + { + text: '🚀  Getting Started', + link: '/use-iapp/getting-started', }, { - text: 'Methods', + text: '📖  Guides', + link: '/use-iapp/guides', collapsed: true, items: [ { - text: 'fetchMyContacts', - link: '/tools/web3telegram/methods/fetchMyContacts', + text: 'Use iApp with Protected Data', + link: '/use-iapp/use-iapp-with-protected-data', }, { - text: 'fetchUserContacts', - link: '/tools/web3telegram/methods/fetchUserContacts', + text: 'Get and Decrypt the Result', + link: '/use-iapp/get-and-decrypt-result', }, { - text: 'sendTelegram', - link: '/tools/web3telegram/methods/sendTelegram', + text: 'Find iApps to Use', + link: '/use-iapp/find-iapps', }, ], }, { - text: 'Integration Guide', - link: '/tools/web3telegram/integration-guide', + text: '💰  How to Pay', + link: '/use-iapp/payment', collapsed: true, items: [ + { + text: 'How to Pay for Web3mail', + link: '/overview/how-to-pay-for-web3mail', + }, { text: 'How to Pay for Web3telegram', link: '/tools/web3telegram/how-to-pay-for-web3telegram', }, + { + text: 'Pricing Considerations', + link: '/overview/pricing-considerations', + }, + { + text: 'Voucher Authorization Guide', + link: '/use-iapp/voucher-guide', + }, ], }, { - text: 'Advanced Configuration', - link: '/tools/web3telegram/advanced-configuration', - }, - ], - }, - { - text: '🧙  Oracle Factory', - link: '/tools/oracle-factory', - collapsed: false, - items: [ - { - text: 'Getting Started', - link: '/tools/oracle-factory/getting-started', + text: '✉  Web3Mail', + link: '/tools/web3mail', + collapsed: true, + items: [ + { + text: 'Getting Started', + link: '/tools/web3mail/getting-started', + }, + { + text: 'Methods', + collapsed: true, + items: [ + { + text: 'fetchMyContacts', + link: '/tools/web3mail/methods/fetchMyContacts', + }, + { + text: 'fetchUserContacts', + link: '/tools/web3mail/methods/fetchUserContacts', + }, + { + text: 'sendEmail', + link: '/tools/web3mail/methods/sendEmail', + }, + ], + }, + { + text: 'Advanced Configuration', + link: '/tools/web3mail/advanced-configuration', + }, + ], }, { - text: 'Methods', + text: '💬  Web3Telegram alpha', + link: '/tools/web3telegram', collapsed: true, items: [ { - text: 'createOracle', - link: '/tools/oracle-factory/methods/createOracle', + text: 'Getting Started', + link: '/tools/web3telegram/getting-started', + }, + { + text: 'Methods', + collapsed: true, + items: [ + { + text: 'fetchMyContacts', + link: '/tools/web3telegram/methods/fetchMyContacts', + }, + { + text: 'fetchUserContacts', + link: '/tools/web3telegram/methods/fetchUserContacts', + }, + { + text: 'sendTelegram', + link: '/tools/web3telegram/methods/sendTelegram', + }, + ], }, { - text: 'readOracle', - link: '/tools/oracle-factory/methods/readOracle', + text: 'Integration Guide', + link: '/tools/web3telegram/integration-guide', }, { - text: 'updateOracle', - link: '/tools/oracle-factory/methods/updateOracle', + text: 'Advanced Configuration', + link: '/tools/web3telegram/advanced-configuration', }, ], }, { - text: 'Advanced Configuration', - link: '/tools/oracle-factory/advanced-configuration', + text: '🧙  Oracle Factory', + link: '/tools/oracle-factory', + collapsed: true, + items: [ + { + text: 'Getting Started', + link: '/tools/oracle-factory/getting-started', + }, + { + text: 'Methods', + collapsed: true, + items: [ + { + text: 'createOracle', + link: '/tools/oracle-factory/methods/createOracle', + }, + { + text: 'readOracle', + link: '/tools/oracle-factory/methods/readOracle', + }, + { + text: 'updateOracle', + link: '/tools/oracle-factory/methods/updateOracle', + }, + ], + }, + { + text: 'Advanced Configuration', + link: '/tools/oracle-factory/advanced-configuration', + }, + ], }, ], }, { - text: 'HELP', - items: [{ text: '🆘  Contact Us', link: '/help/contact-us' }], + text: 'KEY CONCEPTS', + items: [ + { + text: '🔧  iExec SDK', + link: '/key-concepts/sdk', + }, + { + text: '⚙️  Workers & Workerpools', + link: '/key-concepts/workers', + }, + { + text: '📖  Glossary', + link: '/key-concepts/glossary', + }, + ], }, ], } satisfies DefaultTheme.Sidebar; diff --git a/README.md b/README.md index 7c5c6692..614bec5a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# iExec Tools documentation +# iExec Documentation Draft This is the source repository of the -[iExec tools documentation](https://tools.docs.iex.ec) +[iExec documentation draft](https://tools.docs.iex.ec) ## Prerequisites diff --git a/index.md b/index.md index 7abe3788..ea3da0b6 100644 --- a/index.md +++ b/index.md @@ -1,11 +1,11 @@ --- description: - Explore the iExec tools documentation and start building decentralized apps + Explore the iExec documentation draft and start building decentralized apps with data ownership, privacy, and monetization in mind. Learn about Web3Mail, DataProtector, Oracle Factory, Web3Telegram and more. --- -# iExec tools documentation +# iExec Documentation Draft ## Start building with iExec @@ -18,34 +18,86 @@ monetization. 💡  What we do + + 🌍  Hello World + + - 📽  Use case demo + 📽  Use Cases & Demos - - 🔧  How to pay for web3mail + + 🤖  Use the docs in your AI -## Our tools + + 🆘  Contact Us + - - 🔐  DataProtector +## Protect and Manage Data + + + 🚀  Quick Start - - ✉  Web3Mail + + 📚  Core Reference - - 💬  Web3Telegram + + 🔗  Sharing Reference - - 🧙  Oracle Factory + + ⚙️  Advanced Configuration -## Help +## Build Your iApp - - 🆘  Contact us + + 🚀  Quick Start + + + + 📖  Guides + + + + 📚  Reference + + + + 🔧  Advanced Creation + + +## Use An iApp + + + 🚀  Quick Start + + + + 📖  Guides + + + + 💰  How to Pay + + + + 🛠️  DevTools + + +## Key Concepts + + + 🔧  iExec SDK + + + + ⚙️  Workers & Workerpools + + + + 📖  Glossary diff --git a/key-concepts/glossary.md b/key-concepts/glossary.md new file mode 100644 index 00000000..eb7216c1 --- /dev/null +++ b/key-concepts/glossary.md @@ -0,0 +1,15 @@ +--- +description: Glossaire des termes iExec +--- + +# Glossary + +## Structure proposée + +- Glossaire des termes techniques +- Définitions des concepts clés +- Acronymes et abréviations + +## Contenu à développer + +Cette section sera développée avec un glossaire complet des termes utilisés dans l'écosystème iExec. \ No newline at end of file diff --git a/key-concepts/sdk.md b/key-concepts/sdk.md new file mode 100644 index 00000000..963a15d0 --- /dev/null +++ b/key-concepts/sdk.md @@ -0,0 +1,16 @@ +--- +description: iExec SDK bas niveau +--- + +# iExec SDK + +## Structure proposée + +- iExec SDK bas niveau +- Core concepts +- API reference +- Examples + +## Contenu à développer + +Cette section sera développée pour expliquer l'utilisation du SDK iExec bas niveau. \ No newline at end of file diff --git a/key-concepts/workers.md b/key-concepts/workers.md new file mode 100644 index 00000000..ca0f13c4 --- /dev/null +++ b/key-concepts/workers.md @@ -0,0 +1,16 @@ +--- +description: Workers, Workerpools +--- + +# Workers & Workerpools + +## Structure proposée + +- Workers +- Workerpools +- How they work together +- Configuration + +## Contenu à développer + +Cette section sera développée pour expliquer le fonctionnement des Workers et Workerpools. \ No newline at end of file diff --git a/overview/ai-integration.md b/overview/ai-integration.md new file mode 100644 index 00000000..68b1d0b3 --- /dev/null +++ b/overview/ai-integration.md @@ -0,0 +1,16 @@ +--- +description: Use the docs in your AI (vibe coding) +--- + +# Use the docs in your AI + +## Structure proposée + +- Guide d'intégration de la documentation dans les outils d'IA +- Exemples d'utilisation avec différents assistants IA +- Bonnes pratiques pour le "vibe coding" +- Ressources et templates + +## Contenu à développer + +Cette section sera développée pour expliquer comment utiliser la documentation iExec dans les outils d'IA pour améliorer l'expérience de développement. \ No newline at end of file diff --git a/overview/use-cases.md b/overview/use-cases.md new file mode 100644 index 00000000..287ccb5b --- /dev/null +++ b/overview/use-cases.md @@ -0,0 +1,17 @@ +--- +description: Use Cases - AI and Other Emerging Trends +--- + +# Use Cases + +## Structure proposée + +- AI +- Other Emerging Trends +- Demos + +## Contenu à développer + +Cette section sera développée avec les cas d'usage pour l'IA et autres tendances émergentes. + + \ No newline at end of file diff --git a/tools/dataProtector/guides.md b/tools/dataProtector/guides.md new file mode 100644 index 00000000..f2093fd6 --- /dev/null +++ b/tools/dataProtector/guides.md @@ -0,0 +1,15 @@ +--- +description: DataProtector Guides +--- + +# DataProtector Guides + +## Structure proposée + +- Create and Share Access to Protected Data +- Schemas, Dataset Types, etc. (links to iApps) +- Manage Monetization + +## Contenu à développer + +Cette section sera développée avec des guides pratiques pour utiliser DataProtector. \ No newline at end of file diff --git a/tools/dataProtector/what-is-protected-data.md b/tools/dataProtector/what-is-protected-data.md new file mode 100644 index 00000000..14b915bc --- /dev/null +++ b/tools/dataProtector/what-is-protected-data.md @@ -0,0 +1,16 @@ +--- +description: What Is Protected Data? What's the Benefit? +--- + +# What Is Protected Data? + +## Structure proposée + +- What Is Protected Data? +- What's the Benefit? +- Usage in iApps +- Examples and use cases + +## Contenu à développer + +Cette section sera développée pour expliquer ce qu'est une protected data et ses avantages, notamment son utilisation dans les iApps. \ No newline at end of file diff --git a/tools/iapp-generator/advanced-creation.md b/tools/iapp-generator/advanced-creation.md new file mode 100644 index 00000000..7299b30c --- /dev/null +++ b/tools/iapp-generator/advanced-creation.md @@ -0,0 +1,16 @@ +--- +description: Advanced iApp creation techniques +--- + +# Advanced Creation + +## Structure proposée + +- Guides "protocol level" (create iapp without iapp gen) +- Advanced iApp patterns +- Custom configurations +- Performance optimization + +## Contenu à développer + +Cette section sera développée pour expliquer les techniques avancées de création d'iApps. \ No newline at end of file diff --git a/tools/iapp-generator/ai-frameworks.md b/tools/iapp-generator/ai-frameworks.md new file mode 100644 index 00000000..83e7bceb --- /dev/null +++ b/tools/iapp-generator/ai-frameworks.md @@ -0,0 +1,16 @@ +--- +description: AI Frameworks for iApps +--- + +# AI Frameworks + +## Structure proposée + +- Supported AI frameworks +- Integration guides +- Examples and templates +- Best practices + +## Contenu à développer + +Cette section sera développée avec des guides pour intégrer des frameworks IA dans vos iApps. \ No newline at end of file diff --git a/tools/iapp-generator/debug-iapp.md b/tools/iapp-generator/debug-iapp.md new file mode 100644 index 00000000..3aa3469b --- /dev/null +++ b/tools/iapp-generator/debug-iapp.md @@ -0,0 +1,16 @@ +--- +description: Debug Your iApp +--- + +# Debug Your iApp + +## Structure proposée + +- Debugging techniques +- Common issues and solutions +- Monitoring and logging +- Testing strategies + +## Contenu à développer + +Cette section sera développée avec des guides pour déboguer vos iApps. \ No newline at end of file diff --git a/tools/iapp-generator/manage-iapps.md b/tools/iapp-generator/manage-iapps.md new file mode 100644 index 00000000..cd3b5c12 --- /dev/null +++ b/tools/iapp-generator/manage-iapps.md @@ -0,0 +1,16 @@ +--- +description: Manage Your iApps - Orders, Secrets, Inputs, Outputs +--- + +# Manage Your iApps + +## Structure proposée + +- Orders +- Secrets +- Inputs, Outputs (explain the differences, etc.) +- Deployment and monitoring + +## Contenu à développer + +Cette section sera développée avec des guides pour gérer vos iApps. \ No newline at end of file diff --git a/tools/iapp-generator/protocol-level-guides.md b/tools/iapp-generator/protocol-level-guides.md new file mode 100644 index 00000000..c39d191a --- /dev/null +++ b/tools/iapp-generator/protocol-level-guides.md @@ -0,0 +1,16 @@ +--- +description: Protocol-Level Guides (create iApp without iApp Generator) +--- + +# Protocol-Level Guides + +## Structure proposée + +- Create iApp without iApp Generator +- Low-level protocol interactions +- Advanced configurations +- Custom implementations + +## Contenu à développer + +Cette section sera développée avec des guides pour créer des iApps au niveau protocole sans utiliser l'iApp Generator. \ No newline at end of file diff --git a/tools/iapp-generator/tdx-guide.md b/tools/iapp-generator/tdx-guide.md new file mode 100644 index 00000000..f205e9c8 --- /dev/null +++ b/tools/iapp-generator/tdx-guide.md @@ -0,0 +1,16 @@ +--- +description: What Is TDX and How to Use It [EXPERIMENTAL] +--- + +# What Is TDX and How to Use It + +## Structure proposée + +- What is TDX? +- How to use TDX +- Benefits and use cases +- Experimental features and limitations + +## Contenu à développer + +Cette section sera développée pour expliquer TDX et son utilisation (fonctionnalité expérimentale). \ No newline at end of file diff --git a/tools/iapp-generator/what-is-iapp.md b/tools/iapp-generator/what-is-iapp.md new file mode 100644 index 00000000..49ea1ae3 --- /dev/null +++ b/tools/iapp-generator/what-is-iapp.md @@ -0,0 +1,16 @@ +--- +description: What Is an iApp? What Is It Used For? +--- + +# What Is an iApp? + +## Structure proposée + +- What Is an iApp? +- What Is It Used For? +- Key concepts and benefits +- Examples and use cases + +## Contenu à développer + +Cette section sera développée pour expliquer ce qu'est une iApp et ses utilisations. \ No newline at end of file diff --git a/use-iapp/devtools.md b/use-iapp/devtools.md new file mode 100644 index 00000000..8da326e5 --- /dev/null +++ b/use-iapp/devtools.md @@ -0,0 +1,22 @@ +--- +description: Developer tools for working with iApps +--- + +# DevTools + +## Structure proposée + +- Web3Mail +- Web3Telegram +- Oracle Factory +- Autres outils de développement + +## Contenu existant à réutiliser + +- [Web3Mail](../tools/web3mail/) +- [Web3Telegram](../tools/web3telegram/) +- [Oracle Factory](../tools/oracle-factory/) + +## Contenu à développer + +Cette section sera développée pour présenter les outils de développement disponibles. \ No newline at end of file diff --git a/use-iapp/find-iapps.md b/use-iapp/find-iapps.md new file mode 100644 index 00000000..12c483f7 --- /dev/null +++ b/use-iapp/find-iapps.md @@ -0,0 +1,16 @@ +--- +description: Find iApps to Use +--- + +# Find iApps to Use + +## Structure proposée + +- How to discover available iApps +- iApp marketplace and directories +- Evaluation criteria +- Community recommendations + +## Contenu à développer + +Cette section sera développée avec des guides pour trouver et choisir des iApps à utiliser. \ No newline at end of file diff --git a/use-iapp/get-and-decrypt-result.md b/use-iapp/get-and-decrypt-result.md new file mode 100644 index 00000000..4b808086 --- /dev/null +++ b/use-iapp/get-and-decrypt-result.md @@ -0,0 +1,16 @@ +--- +description: Get and Decrypt the Result +--- + +# Get and Decrypt the Result + +## Structure proposée + +- How to retrieve iApp results +- Decryption process +- Result formats and handling +- Error handling and troubleshooting + +## Contenu à développer + +Cette section sera développée avec des guides pour récupérer et décrypter les résultats des iApps. \ No newline at end of file diff --git a/use-iapp/getting-started.md b/use-iapp/getting-started.md new file mode 100644 index 00000000..976a9f65 --- /dev/null +++ b/use-iapp/getting-started.md @@ -0,0 +1,25 @@ +--- +description: Learn how to use iApps and developer tools +--- + +# Use An iApp - Getting Started + +## Structure proposée + +- Intro, différence entre tools et autres iApps +- Guides +- Use an iApp with a protectedData (DP) +- Get and decrypt the result +- Find iApps to use ? +- How to pay for execution + +## Contenu existant à réutiliser + +- [Web3Mail](../tools/web3mail.md) +- [Web3Telegram](../tools/web3telegram.md) +- [Oracle Factory](../tools/oracle-factory.md) +- [How to pay for web3mail](../overview/how-to-pay-for-web3mail.md) + +## Contenu à développer + +Cette section sera développée pour expliquer comment utiliser les iApps existantes et les outils de développement. \ No newline at end of file diff --git a/use-iapp/guides.md b/use-iapp/guides.md new file mode 100644 index 00000000..41232bbe --- /dev/null +++ b/use-iapp/guides.md @@ -0,0 +1,16 @@ +--- +description: Guides for using iApps effectively +--- + +# Use An iApp - Guides + +## Structure proposée + +- Use an iApp with a protectedData (DP) +- Get and decrypt the result +- Find iApps to use +- Best practices + +## Contenu à développer + +Cette section sera développée avec des guides pratiques pour utiliser les iApps. \ No newline at end of file diff --git a/use-iapp/introduction.md b/use-iapp/introduction.md new file mode 100644 index 00000000..c5527bb6 --- /dev/null +++ b/use-iapp/introduction.md @@ -0,0 +1,16 @@ +--- +description: Introduction, Differences Between Tools and Other iApps +--- + +# Introduction + +## Structure proposée + +- Introduction to using iApps +- Differences Between Tools and Other iApps +- When to use which approach +- Overview of available options + +## Contenu à développer + +Cette section sera développée pour expliquer les différences entre les outils et autres iApps. \ No newline at end of file diff --git a/use-iapp/payment.md b/use-iapp/payment.md new file mode 100644 index 00000000..3cf6de7e --- /dev/null +++ b/use-iapp/payment.md @@ -0,0 +1,20 @@ +--- +description: How to pay for iApp execution +--- + +# How to Pay for Execution + +## Structure proposée + +- RLC +- Voucher +- Auth to use voucher guide + +## Contenu existant à réutiliser + +- [How to pay for web3mail](../overview/how-to-pay-for-web3mail.md) +- [Pricing considerations](../overview/pricing-considerations.md) + +## Contenu à développer + +Cette section sera développée pour expliquer les différentes méthodes de paiement pour l'exécution des iApps. \ No newline at end of file diff --git a/use-iapp/use-iapp-with-protected-data.md b/use-iapp/use-iapp-with-protected-data.md new file mode 100644 index 00000000..552baf55 --- /dev/null +++ b/use-iapp/use-iapp-with-protected-data.md @@ -0,0 +1,16 @@ +--- +description: Use an iApp with Protected Data (DataProtector) +--- + +# Use an iApp with Protected Data + +## Structure proposée + +- How to use iApps with Protected Data +- DataProtector integration +- Step-by-step guides +- Examples and best practices + +## Contenu à développer + +Cette section sera développée avec des guides pour utiliser des iApps avec des données protégées. \ No newline at end of file diff --git a/use-iapp/voucher-guide.md b/use-iapp/voucher-guide.md new file mode 100644 index 00000000..185fadbb --- /dev/null +++ b/use-iapp/voucher-guide.md @@ -0,0 +1,16 @@ +--- +description: Guide - How to Authorize the Use of a Voucher +--- + +# How to Authorize the Use of a Voucher + +## Structure proposée + +- What are vouchers? +- How to authorize voucher use +- Step-by-step authorization process +- Best practices and security considerations + +## Contenu à développer + +Cette section sera développée avec un guide pour autoriser l'utilisation de vouchers. \ No newline at end of file diff --git a/utils/wagmiConfig.ts b/utils/wagmiConfig.ts index ff52427e..3a7e64ee 100644 --- a/utils/wagmiConfig.ts +++ b/utils/wagmiConfig.ts @@ -10,8 +10,8 @@ const projectId = import.meta.env.VITE_REOWN_PROJECT_ID; // WalletConnect metadata const metadata = { - name: 'iExec Documentation tools', - description: 'iExec Documentation tools', + name: 'iExec Documentation Draft', + description: 'iExec Documentation Draft', url: 'https://tools.docs.iex.ec/', icons: [ 'https://cdn.prod.website-files.com/6646148828eddb19c172bf2a/665db3ba85a625628c353a64_Logo-RLC-Yellow.png',