Skip to content

Commit ee3111c

Browse files
feat: add intro + getting started + few guides (#29)
Co-authored-by: Robin Le Caignec <[email protected]> Co-authored-by: Le-Caignec <[email protected]>
1 parent 0dcc3ac commit ee3111c

12 files changed

+1679
-45
lines changed

.vitepress/sidebar.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -192,17 +192,13 @@ export function getSidebar() {
192192
text: 'Different Ways to Execute an iApp',
193193
link: '/guides/use-iapp/different-ways-to-execute',
194194
},
195-
{
196-
text: 'Add Inputs to the Execution',
197-
link: '/guides/use-iapp/add-inputs-to-execution',
198-
},
199195
{
200196
text: 'Use iApp with Protected Data',
201197
link: '/guides/use-iapp/use-iapp-with-protected-data',
202198
},
203199
{
204-
text: 'Find iApps to Use',
205-
link: '/guides/use-iapp/find-iapps',
200+
text: 'Add Inputs to the Execution',
201+
link: '/guides/use-iapp/add-inputs-to-execution',
206202
},
207203
{
208204
text: 'How to Pay the Executions',

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,25 @@ Fork this repository and ensure you're working on the `main` branch:
139139
> - All pull requests are reviewed by our team before being merged
140140
> - Feel free to ask questions in the pull request if you need clarification
141141
142+
### Some conventions
143+
144+
In order to keep the documentation consistent, we have some naming conventions
145+
for input parameters:
146+
147+
- `protectedData`: '0x123abc...',
148+
- `protectedDataAddress`: '0x123abc...',
149+
- `authorizedApp`: '0x456def...',
150+
- `authorizedUser`: '0x789cba...',
151+
- `userAddress`: '0x789cba...',
152+
- `appWhitelist`: '0xba46d6...',
153+
- `owner`: '0xa0c15e...',
154+
- `newOwner`: '0xc5e9f4...',
155+
- `voucherOwner`: '0x5714eB...',
156+
- `renterAddress`: '0x246bdf...'
157+
- `subscriberAddress`: '0x246bdf...'
158+
- `workerpool`: '0xa5de76...'
159+
- `taskId`: '0x7ac398...'
160+
142161
## 🆘 Support
143162

144163
- 📖 [Documentation](https://docs.iex.ec)

package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"@wagmi/vue": "^0.1.24",
2222
"clsx": "^2.1.1",
2323
"figlet": "^1.8.2",
24+
"iexec": "^8.18.0",
2425
"pinia": "^3.0.3",
2526
"reka-ui": "^2.4.1",
2627
"tailwind-merge": "^3.3.1",

src/assets/use-iapp/iexec-actors-diagram.svg

Lines changed: 103 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)