Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
628 changes: 372 additions & 256 deletions .vitepress/sidebar.ts

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
86 changes: 69 additions & 17 deletions index.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -18,34 +18,86 @@ monetization.
💡  What we do
</a>

<a href="./overview/helloWorld" class="link-for-home">
🌍 &nbsp;Hello World
</a>

<a href="./overview/use-case-demo" class="link-for-home">
📽 &nbsp;Use case demo
📽 &nbsp;Use Cases & Demos
</a>

<a href="./overview/how-to-pay-for-web3mail" class="link-for-home">
🔧 &nbsp;How to pay for web3mail
<a href="./overview/ai-integration" class="link-for-home">
🤖 &nbsp;Use the docs in your AI
</a>

## Our tools
<a href="./help/contact-us" class="link-for-home">
🆘 &nbsp;Contact Us
</a>

<a href="./tools/dataProtector" class="link-for-home">
🔐 &nbsp;DataProtector
## Protect and Manage Data

<a href="./tools/dataProtector/getting-started" class="link-for-home">
🚀 &nbsp;Quick Start
</a>

<a href="./tools/web3mail" class="link-for-home">
&nbsp;Web3Mail
<a href="./tools/dataProtector/dataProtectorCore" class="link-for-home">
📚 &nbsp;Core Reference
</a>

<a href="./tools/web3telegram" class="link-for-home">
💬 &nbsp;Web3Telegram
<a href="./tools/dataProtector/dataProtectorSharing" class="link-for-home">
🔗 &nbsp;Sharing Reference
</a>

<a href="./tools/oracle-factory" class="link-for-home">
🧙 &nbsp;Oracle Factory
<a href="./tools/dataProtector/advanced/advanced-configuration" class="link-for-home">
⚙️ &nbsp;Advanced Configuration
</a>

## Help
## Build Your iApp

<a href="./help/contact-us" class="link-for-home">
🆘 &nbsp;Contact us
<a href="./tools/iapp-generator/getting-started" class="link-for-home">
🚀 &nbsp;Quick Start
</a>

<a href="./tools/iapp-generator/building-your-iexec-app" class="link-for-home">
📖 &nbsp;Guides
</a>

<a href="./tools/iapp-generator" class="link-for-home">
📚 &nbsp;Reference
</a>

<a href="./tools/iapp-generator/advanced-creation" class="link-for-home">
🔧 &nbsp;Advanced Creation
</a>

## Use An iApp

<a href="./use-iapp/getting-started" class="link-for-home">
🚀 &nbsp;Quick Start
</a>

<a href="./use-iapp/guides" class="link-for-home">
📖 &nbsp;Guides
</a>

<a href="./use-iapp/payment" class="link-for-home">
💰 &nbsp;How to Pay
</a>

<a href="./use-iapp/devtools" class="link-for-home">
🛠️ &nbsp;DevTools
</a>

## Key Concepts

<a href="./key-concepts/sdk" class="link-for-home">
🔧 &nbsp;iExec SDK
</a>

<a href="./key-concepts/workers" class="link-for-home">
⚙️ &nbsp;Workers & Workerpools
</a>

<a href="./key-concepts/glossary" class="link-for-home">
📖 &nbsp;Glossary
</a>
15 changes: 15 additions & 0 deletions key-concepts/glossary.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions key-concepts/sdk.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions key-concepts/workers.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions overview/ai-integration.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 17 additions & 0 deletions overview/use-cases.md
Original file line number Diff line number Diff line change
@@ -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.


15 changes: 15 additions & 0 deletions tools/dataProtector/guides.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/dataProtector/what-is-protected-data.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/advanced-creation.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/ai-frameworks.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/debug-iapp.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/manage-iapps.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/protocol-level-guides.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions tools/iapp-generator/tdx-guide.md
Original file line number Diff line number Diff line change
@@ -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).
16 changes: 16 additions & 0 deletions tools/iapp-generator/what-is-iapp.md
Original file line number Diff line number Diff line change
@@ -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.
Loading