Skip to content

Commit 57eee4b

Browse files
committed
docs: update README and enhance data protection documentation
Added explanations for TDX vs SGX, a recap of Workerpool addresses for chains, and noted ENS support on Bellecour in the README. Enhanced various data protection documentation files by importing RequiredBadge and OptionalBadge components for better clarity and consistency.
1 parent 9904b8c commit 57eee4b

39 files changed

+160
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,6 @@ for input parameters:
192192
- migrate github SDK doc here
193193
- migrate pay-per-task page into a guide
194194
- check pages (introduction & getting-started) for use-iapp guide
195+
- explain TDX vs SGX
196+
- Give recap of Workerpool address fo chains
197+
- Talk about ENS on Bellecour(it's not supported on arbitrum)

src/components/ChainNotSupportedBadge.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const shouldShow = computed(() => isArbitrumSelected.value);
2121
text="Not Supported for this Chain"
2222
style="
2323
color: var(--vp-c-orange-1);
24-
background-color: hsla(0, 100%, 70%, 8%);
24+
background-color: hsla(15, 100%, 40%, 8%);
2525
margin-top: 1px;
2626
margin-right: 4px;
2727
"

src/guides/manage-data/manage-access.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,3 +228,8 @@ steps:
228228
[schemas and dataset types](/guides/manage-data/handle-schemas-dataset-types)
229229
- **Monetize data**: Explore
230230
[data monetization strategies](/guides/manage-data/monetize-protected-data)
231+
232+
<script setup>
233+
import RequiredBadge from '@/components/RequiredBadge.vue'
234+
import OptionalBadge from '@/components/OptionalBadge.vue'
235+
</script>

src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector';
9696
```
9797

9898
See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash)
99+
100+
<script setup>
101+
import RequiredBadge from '@/components/RequiredBadge.vue'
102+
</script>

src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,7 @@ import { type GetUserAppWhitelistResponse } from '@iexec/dataprotector';
5959
// Child types
6060
import { type AddOnlyAppWhitelist } from '@iexec/dataprotector';
6161
```
62+
63+
<script setup>
64+
import OptionalBadge from '@/components/OptionalBadge.vue'
65+
</script>

src/references/dataProtector/dataProtectorCore/getGrantedAccess.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,3 +217,7 @@ smaller than the page size.
217217
**Type:** GrantedAccess
218218

219219
See [`GrantedAccess`](../types.md#grantedaccess)
220+
221+
<script setup>
222+
import OptionalBadge from '@/components/OptionalBadge.vue'
223+
</script>

src/references/dataProtector/dataProtectorCore/getProtectedData.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,3 +191,7 @@ import { type ProtectedData } from '@iexec/dataprotector';
191191
```
192192

193193
See [`ProtectedData`](../types.md#protecteddata)
194+
195+
<script setup>
196+
import OptionalBadge from '@/components/OptionalBadge.vue'
197+
</script>

src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,10 @@ import { type GetResultFromCompletedTaskResponse } from '@iexec/dataprotector';
134134
`ArrayBuffer`
135135

136136
The actual content of the protected file.
137+
138+
```
139+
140+
<script setup>
141+
import RequiredBadge from '@/components/RequiredBadge.vue'
142+
import OptionalBadge from '@/components/OptionalBadge.vue'
143+
</script>

src/references/dataProtector/dataProtectorCore/grantAccess.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,3 +250,8 @@ The result of this method confirms the new access grant. It consists of a JSON
250250
`grantedAccess` object.
251251

252252
[`GrantedAccess`](../types.md#grantedaccess)
253+
254+
<script setup>
255+
import RequiredBadge from '@/components/RequiredBadge.vue'
256+
import OptionalBadge from '@/components/OptionalBadge.vue'
257+
</script>

src/references/dataProtector/dataProtectorCore/protectData.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,4 +439,6 @@ To further check your data was correctly created, you can inspect it on the
439439
<script setup>
440440
// Assets
441441
import explorerDatasetImage from '@/assets/explorer-dataset-example.png';
442+
import RequiredBadge from '@/components/RequiredBadge.vue'
443+
import OptionalBadge from '@/components/OptionalBadge.vue'
442444
</script>

0 commit comments

Comments
 (0)