Skip to content

Commit efaa175

Browse files
committed
Enhance sidebar navigation and update code formatting in documentation
- Added new items to the sidebar for 'Toolkit' and additional iExec overview topics to improve user navigation. - Updated code block formatting in the Proof of Contribution documentation from 'sol' to 'text' for better clarity and consistency. - Removed outdated nested structure in the sidebar for the PoCo section, streamlining the navigation experience.
1 parent 22eacc9 commit efaa175

File tree

2 files changed

+34
-28
lines changed

2 files changed

+34
-28
lines changed

.vitepress/sidebar.ts

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ export function getSidebar() {
77
text: 'GET STARTED',
88
items: [
99
{ text: '💡 Welcome', link: '/get-started/welcome' },
10+
{
11+
text: '🛠️ Toolkit',
12+
link: '/get-started/toolkit',
13+
},
1014
{
1115
text: '👋 Hello World',
1216
link: '/get-started/helloWorld',
@@ -51,6 +55,10 @@ export function getSidebar() {
5155
{
5256
text: 'iExec OVERVIEW',
5357
items: [
58+
{
59+
text: '❓ What is iExec ?',
60+
link: '/get-started/overview/what-is-iexec',
61+
},
5462
{
5563
text: '❓  What is Protected Data ?',
5664
link: '/get-started/overview/what-is-protected-data',
@@ -59,6 +67,10 @@ export function getSidebar() {
5967
text: '❓ What is an iApp ?',
6068
link: '/get-started/overview/what-is-iapp',
6169
},
70+
{
71+
text: '❓ What is a Workerpool ?',
72+
link: '/get-started/overview/what-is-workerpool',
73+
},
6274
{
6375
text: '🪙 RLC Token',
6476
link: '/get-started/rlc',
@@ -93,6 +105,14 @@ export function getSidebar() {
93105
{
94106
text: 'PROTOCOL',
95107
items: [
108+
{
109+
text: '💸 Pay Per Task Model',
110+
link: '/get-started/protocol/poco/pay-per-task',
111+
},
112+
{
113+
text: '🛡️ Proof of Contribution',
114+
link: '/get-started/protocol/poco/proof-of-contribution',
115+
},
96116
{
97117
text: '⚙️ Workers & Workerpools',
98118
collapsed: true,
@@ -107,20 +127,6 @@ export function getSidebar() {
107127
},
108128
],
109129
},
110-
{
111-
text: '⛓️‍💥 PoCo',
112-
collapsed: true,
113-
items: [
114-
{
115-
text: '💸 Pay Per Task Model',
116-
link: '/get-started/protocol/poco/pay-per-task',
117-
},
118-
{
119-
text: '🛡️ Proof of Contribution',
120-
link: '/get-started/protocol/poco/proof-of-contribution',
121-
},
122-
],
123-
},
124130
],
125131
},
126132
],

src/get-started/protocol/proof-of-contribution.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -621,21 +621,21 @@ Orders compatibility required:
621621

622622
**1. The worker pool’s category and the requester’s category must be equal.**
623623

624-
```sol
624+
```text
625625
require(_requestorder.category == _workerpoolorder.category);
626626
```
627627

628628
**2. The worker pool’s trust must be greater or equal to the requester’s
629629
trust.**
630630

631-
```sol
631+
```text
632632
require(_requestorder.trust == _workerpoolorder.trust);
633633
```
634634

635635
**3. The app’s, dataset’s and worker pool’s prices must be less or equal to the
636636
requester’s appmaxprice, datasetmaxprice and workerpoolmaxprice.**
637637

638-
```sol
638+
```text
639639
require(_requestorder.appmaxprice >= _apporder.appprice);
640640
require(_requestorder.datasetmaxprice >= _datasetorder.datasetprice);
641641
require(_requestorder.workerpoolmaxprice >= _workerpoolorder.workerpoolprice);
@@ -644,82 +644,82 @@ require(_requestorder.workerpoolmaxprice >= _workerpoolorder.workerpoolprice);
644644
**4. The worker pool’s tag must enable all the features required by the app’s
645645
tag, the dataset’s tag and the worker pool’s tag.**
646646

647-
```sol
647+
```text
648648
require(tag & ~_workerpoolorder.tag == 0x0);
649649
require(tag & ~_workerpoolorder.tag == 0x0);
650650
```
651651

652652
**5. If TEE tag is required, then application must be TEE compatible.**
653653

654-
```sol
654+
```text
655655
require((tag ^ _apporder.tag)[31] & 0x01 == 0x0);
656656
```
657657

658658
**6. The app provided by the apporder must match the one required by the
659659
requester.**
660660

661-
```sol
661+
```text
662662
require(_requestorder.app == _apporder.app);
663663
```
664664

665665
**7. The dataset provided by the datasetorder must match the one required by the
666666
requester.**
667667

668-
```sol
668+
```text
669669
require(_requestorder.dataset == _datasetorder.dataset);
670670
```
671671

672672
**8. If the requester specified a worker pool restriction, the worker pool must
673673
match this value or be part of the corresponding group.**
674674

675-
```sol
675+
```text
676676
require(_checkIdentity(_requestorder.workerpool, _workerpoolorder.workerpool, GROUPMEMBER_PURPOSE));
677677
```
678678

679679
**9. The application must fit the dataset’s and the worker pool’s application
680680
restrictions (if any).**
681681

682-
```sol
682+
```text
683683
require(_checkIdentity(_datasetorder.apprestrict, _apporder.app, GROUPMEMBER_PURPOSE));
684684
require(_checkIdentity(_workerpoolorder.apprestrict, _apporder.app, GROUPMEMBER_PURPOSE));
685685
```
686686

687687
**10. The dataset must fit the application’s and the worker pool’s restrictions
688688
(if any).**
689689

690-
```sol
690+
```text
691691
require(_checkIdentity(_apporder.datasetrestrict, _datasetorder.dataset, GROUPMEMBER_PURPOSE));
692692
require(_checkIdentity(_workerpoolorder.datasetrestrict, _datasetorder.dataset, GROUPMEMBER_PURPOSE));
693693
```
694694

695695
**11. The worker pool must fit the application’s and the dataset’s restrictions
696696
(if any).**
697697

698-
```sol
698+
```text
699699
require(_checkIdentity(_apporder.workerpoolrestrict, _workerpoolorder.workerpool, GROUPMEMBER_PURPOSE));
700700
require(_checkIdentity(_datasetorder.workerpoolrestrict, _workerpoolorder.workerpool, GROUPMEMBER_PURPOSE));
701701
```
702702

703703
**12. The requester must fit the application’s, the dataset’s and the worker
704704
pool’s restrictions (if any).**
705705

706-
```sol
706+
```text
707707
require(_checkIdentity(_apporder.requesterrestrict, _requestorder.requester, GROUPMEMBER_PURPOSE));
708708
require(_checkIdentity(_datasetorder.requesterrestrict, _requestorder.requester, GROUPMEMBER_PURPOSE));
709709
require(_checkIdentity(_workerpoolorder.requesterrestrict, _requestorder.requester, GROUPMEMBER_PURPOSE));
710710
```
711711

712712
**13. All resources must be registered in the corresponding registries.**
713713

714-
```sol
714+
```text
715715
require(m_appregistry.isRegistered(_apporder.app));
716716
require(m_datasetregistry.isRegistered(_datasetorder.dataset));
717717
require(m_workerpoolregistry.isRegistered(_workerpoolorder.workerpool));
718718
```
719719

720720
**14. All orders must be signed or presigned.**
721721

722-
```sol
722+
```text
723723
require(_checkPresignatureOrSignature(App(_apporder.app).m_owner(), _apporder.hash(), _apporder.sign));
724724
require(_checkPresignatureOrSignature(Dataset(_datasetorder.dataset).m_owner(), _datasetorder.hash(), _datasetorder.sign));
725725
require(_checkPresignatureOrSignature(Workerpool(_workerpoolorder.workerpool).m_owner(), _workerpoolorder.hash(), _workerpoolorder.sign));

0 commit comments

Comments
 (0)