Skip to content

Commit 48eb0c4

Browse files
committed
Update sidebar icons and enhance SDK documentation with new sections and links
1 parent e4c8460 commit 48eb0c4

File tree

4 files changed

+33
-8
lines changed

4 files changed

+33
-8
lines changed

.vitepress/sidebar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -552,11 +552,11 @@ export function getSidebar() {
552552
],
553553
},
554554
{
555-
text: '⚙️ PoCo',
555+
text: '⛓️‍💥 PoCo',
556556
collapsed: true,
557557
items: [
558558
{
559-
text: ' Pay Per Task Model',
559+
text: '💸 Pay Per Task Model',
560560
link: '/documentation/protocol/poco/pay-per-task',
561561
},
562562
{

src/documentation/protocol/poco/proof-of-contribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ consensus on a given result. Its logic is detailed in two blog articles:
7676

7777
The
7878
[nominal workflow](https://github.com/iExecBlockchainComputing/iexec-doc/raw/master/techreport/nominalworkflow-ODB.png)
79-
is also available in the [technical report section](../help/glossary.md)
79+
is also available in the [technical report section](../glossary.md)
8080

8181
Below are the details of the implementations:
8282

src/documentation/protocol/sdk.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,33 @@ title: iExec SDK
33
description: iExec SDK
44
---
55

6-
# 🔧 iExec SDK
6+
# iExec SDK
77

8-
This page is under development.
8+
The iExec SDK is a [CLI](#command-line-interface) and a
9+
[JS library](#javascripttypescript-library) that allows easy interactions with
10+
iExec decentralized marketplace in order to run off-chain computations.
911

10-
<!-- TODO: Add SDK content -->
12+
iExec SDK is available on [npm](https://www.npmjs.com/package/iexec) and
13+
[GitHub](https://github.com/iExecBlockchainComputing/iexec-sdk)
14+
15+
## Command Line Interface
16+
17+
The CLI documentation is available
18+
[here](https://github.com/iExecBlockchainComputing/iexec-sdk/blob/master/docs/README.md)
19+
20+
## JavaScript/TypeScript Library
21+
22+
The library documentation is available
23+
[here](https://github.com/iExecBlockchainComputing/iexec-sdk/blob/master/docs/README.md)
24+
25+
### Browser integration
26+
27+
<a href="https://codesandbox.io/p/github/iExecBlockchainComputing/iexec-sdk-sandbox-buy-computation/main?file=%2Fsrc%2Findex.js&moduleview=1&theme=dark" target="_blank" rel="noreferrer" class="link-as-block" style="margin-top: 16px">
28+
&nbsp;Code Sandbox
29+
</a>
30+
31+
### NodeJS integration
32+
33+
<a href="https://codesandbox.io/p/sandbox/iexec-sdk-nodejs-hu6n6v?file=%2Findex.js" target="_blank" rel="noreferrer" class="link-as-block" style="margin-top: 16px">
34+
&nbsp;Code Sandbox
35+
</a>

src/documentation/protocol/worker/manage-access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ The supported tags for workerpool orders are:
6868

6969
1. Do not publish workerpool orders with a tag value out of the specified list.
7070
Such an order could produce undesirable and unpredictable behaviors. The
71-
[iExec SDK](../for-developers/toolbox/iexec-sdk.md) implements all required
72-
preflight checks to avoid erroneous orders publishing.
71+
[iExec SDK](../sdk.md) implements all required preflight checks to avoid
72+
erroneous orders publishing.
7373
2. Currently, TEE workflow do not support tasks replication on several workers.
7474
TEE workerpool orders must be published with `trust` value equal to `1`.
7575
3. TEE tasks with Gramine TEE framework are not supported yet. Do not publish

0 commit comments

Comments
 (0)