Skip to content

feat: write content for toolkit page #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 22, 2025
Merged

feat: write content for toolkit page #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
26830b0
feat: enhance documentation with new toolkit overview and iApp genera…
Le-Caignec Aug 22, 2025
8f2da1a
docs: improve formatting and readability in toolkit documentation
Le-Caignec Aug 22, 2025
7f4c2df
feat: remove 'Build your first application' section from sidebar and …
Le-Caignec Aug 22, 2025
c7f1762
fix: update link for Web3 Messaging integration and remove collapsed …
Le-Caignec Aug 22, 2025
16c73f2
docs: update and enhance the iApp deployment and execution sections i…
Le-Caignec Aug 22, 2025
a0c99d4
docs: update links in iApp guides for consistency and clarity
Le-Caignec Aug 22, 2025
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
8 changes: 1 addition & 7 deletions .vitepress/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,6 @@ export function getSidebar() {
text: 'Quick Start',
link: '/guides/build-iapp/advanced/quick-start',
},
{
text: 'Build your first application',
link: '/guides/build-iapp/advanced/build-your-first-iapp',
},
{
text: 'Build your first SGX app',
link: '/guides/build-iapp/advanced/build-your-first-sgx-iapp',
Expand Down Expand Up @@ -202,7 +198,7 @@ export function getSidebar() {
},
{
text: 'Integrate Web3 Messaging',
link: '/guides/use-iapp/web3-messaging',
link: '/guides/use-iapp/integrate-web3-messaging',
},
],
},
Expand Down Expand Up @@ -551,7 +547,6 @@ export function getSidebar() {
},
{
text: 'Workers & Workerpools',
collapsed: true,
items: [
{
text: 'Worker Quick Start',
Expand All @@ -565,7 +560,6 @@ export function getSidebar() {
},
{
text: '🔒 TEE Technology',
collapsed: true,
items: [
{
text: 'Introduction to TEE Technologies',
Expand Down
9 changes: 1 addition & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,9 @@ for input parameters:

## TODO

- Adapt hardcoded address to feat with new contracts deployed on arbitrum
- Add link to the new explorer feature Asset_Types in the guide =>
`handle-schemas-dataset-types`
- Add link to remix for deploying whitelist
- complete `use-iapp` section
- Maybe split input and output in two diff sub section in build your iapp guide
- Explorer l'intégration de codeSpace
- Add a Development workflow section (1 - ProtectData, 2- ...)
Expand All @@ -239,25 +237,20 @@ for input parameters:
- Update the Dune Dashboard to the final version
- Add new section in `iexec-explorer.md` file to talk about: available chain on
the UI + SRLC/RLC on account section feature of the protocol
- Update or add design illustrations based on the new design system
- Check how to pay guide to update with the launch on Arbitrum (RLC vs xRLC)
- framework AI supporté
- check glossary
- migrate github iexec SDK doc here
- migrate pay-per-task page into a guide
- check pages (introduction & getting-started) for use-iapp guide
- Schema what is iexec to do and implement
- Give recap of Workerpool address fo chains
- Talk about ENS on Bellecour(it's not supported on arbitrum)
- Rework Advanced iApp building guides. (from "old" protocol doc) <<<<<<< HEAD
- Talk about encrypting results in use-iapp
- Refactor "advanced" section in build-iapp
- Rework src\get-started\protocol\iexec-doracle.md (transfer to guide or
rewrite)
- Talk about encrypting results in use-iapp
- Refactor "advanced" section in build-iapp
- Rework src\get-started\protocol\oracle.md (transfer to guide or rewrite)
- Talk about iApp secret
- Improve Guide in build-iapp section - be more clear for builder ( how to
process process protectedData, clarify input-output guide)
- refactor iapp generator cli reference
- Add illustration in the different pages
43 changes: 41 additions & 2 deletions src/get-started/toolkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,45 @@

# 🛠️ iExec Toolkit

This page is under development.
Build faster and smarter with our turnkey toolkit designed to streamline your

Check warning on line 8 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L8 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 8, "column": 31}}}, "severity": "WARNING"}
iExec development experience.

<!-- TODO: Add comprehensive toolkit overview -->
## 🚀 iApp Generator

The **iApp Generator** is your quick-start solution for creating iExec
confidential decentralized applications. Generate production-ready iApp with
just a few commands, let free your imagination.

### Key Features

Check warning on line 17 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L17 

[Google.Headings] 'Key Features' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Key Features' should use sentence-style capitalization.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 17, "column": 5}}}, "severity": "WARNING"}

- **Development templates** that simplify iApp development
- **Streamlined wallet management** for easy app deployment
- **Governance management** to control who accesses your app, when, and at what
price

### Get Started

Check warning on line 24 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L24 

[Google.Headings] 'Get Started' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Get Started' should use sentence-style capitalization.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 24, "column": 5}}}, "severity": "WARNING"}

Jump right into building with our comprehensive guide:

Check warning on line 26 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L26 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 26, "column": 31}}}, "severity": "WARNING"}
[Building Your iApp →](/references/iapp-generator/building-your-iexec-app.md)

## 🔒 DataProtector-SDK

The **DataProtector-SDK** provides a complete toolkit for managing confidential
data on iExec. Protect, share, and monetize your data by exposing the protected
asset type on the iExec protocol without revealing the actual value, allowing
users to pay for access.

### Key Features

Check warning on line 36 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L36 

[Google.Headings] 'Key Features' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Key Features' should use sentence-style capitalization.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 36, "column": 5}}}, "severity": "WARNING"}

- **Easy data protection** through SDK methods
- **Asset visualization** to easily view and explore protected asset types on
the iExec protocol
- **Content consumption** capabilities for accessing protected data through
confidential iExec applications (iApps)

Check notice on line 42 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L42 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 42, "column": 35}}}, "severity": "INFO"}

Check failure on line 42 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L42 

[Vale.Spelling] Did you really mean 'iApps'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'iApps'?", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 42, "column": 36}}}, "severity": "ERROR"}
- **Governance management** to control who accesses your data, when, and at what
price

### Get Started

Check warning on line 46 in src/get-started/toolkit.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/get-started/toolkit.md#L46 

[Google.Headings] 'Get Started' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Get Started' should use sentence-style capitalization.", "location": {"path": "src/get-started/toolkit.md", "range": {"start": {"line": 46, "column": 5}}}, "severity": "WARNING"}

Learn how to protect and manage your data:
[DataProtector Getting Started →](/references/dataProtector/getting-started.md)
Loading