Skip to content

Commit 93e8770

Browse files
Le-CaignecLe-Caignec
committed
Update documentation for improved navigation and content organization
- Added new items to the README for upcoming tasks, including checking the glossary and migrating documentation. - Updated sidebar links for consistency, changing 'Documentation' to 'Get Started' and restructuring links to reflect the new directory layout. - Removed outdated references and ensured all links point to the correct paths for better user experience. - Deleted obsolete files related to Web3Mail and Web3Telegram, consolidating their documentation into the references section.
1 parent 741ff78 commit 93e8770

35 files changed

+155
-195
lines changed

‎.vitepress/config.mts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export default defineConfig({
9898
themeConfig: {
9999
// https://vitepress.dev/reference/default-theme-config
100100
nav: [
101-
{ text: 'Documentation', link: '/get-started/welcome' },
101+
{ text: 'Get Started', link: '/get-started/welcome' },
102102
{ text: 'Guides', link: '/guides/build-iapp/' },
103103
{ text: 'References', link: '/references/dataProtector' },
104104
{

‎.vitepress/sidebar.ts‎

Lines changed: 99 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,26 @@ export function getSidebar() {
4242
text: '📋 Use Cases',
4343
link: '/get-started/use-cases',
4444
},
45-
{
46-
text: '🪙 RLC Token',
47-
link: '/get-started/rlc',
48-
},
4945
{
5046
text: '🤖 Develop with AI',
5147
link: '/get-started/develop-with-ai',
5248
},
5349
],
5450
},
5551
{
56-
text: 'WHAT IS iExec ?',
52+
text: 'iExec OVERVIEW',
5753
items: [
5854
{
5955
text: '❓  What is Protected Data ?',
60-
link: '/get-started/what-is-iexec/what-is-protected-data',
56+
link: '/get-started/overview/what-is-protected-data',
6157
},
6258
{
6359
text: '❓ What is an iApp ?',
64-
link: '/get-started/what-is-iexec/build-iapp/what-is-iapp',
60+
link: '/get-started/overview/what-is-iapp',
61+
},
62+
{
63+
text: '🪙 RLC Token',
64+
link: '/get-started/rlc',
6565
},
6666
],
6767
},
@@ -151,27 +151,27 @@ export function getSidebar() {
151151
items: [
152152
{
153153
text: 'Build and Deploy',
154-
link: '/guides/build-iapp/guides/build-&-deploy',
154+
link: '/guides/build-iapp/build-&-deploy',
155155
},
156156
{
157157
text: 'Manage Access',
158-
link: '/guides/build-iapp/guides/manage-access',
158+
link: '/guides/build-iapp/manage-access',
159159
},
160160
{
161161
text: 'Inputs and Outputs',
162-
link: '/guides/build-iapp/guides/inputs-and-outputs',
162+
link: '/guides/build-iapp/inputs-and-outputs',
163163
},
164164
{
165165
text: 'Using TDX',
166-
link: '/guides/build-iapp/guides/using-tdx',
166+
link: '/guides/build-iapp/using-tdx',
167167
},
168168
{
169169
text: 'How to Get and Decrypt Results',
170-
link: '/guides/build-iapp/guides/how-to-get-and-decrypt-results',
170+
link: '/guides/build-iapp/how-to-get-and-decrypt-results',
171171
},
172172
{
173173
text: 'Debugging',
174-
link: '/guides/build-iapp/guides/debugging',
174+
link: '/guides/build-iapp/debugging',
175175
},
176176
],
177177
},
@@ -180,31 +180,31 @@ export function getSidebar() {
180180
items: [
181181
{
182182
text: '📝 Introduction',
183-
link: '/guides/what-is-iexec/introduction',
183+
link: '/guides/use-iapp/introduction',
184184
},
185185
{
186186
text: '🚀 Getting Started',
187-
link: '/guides/what-is-iexec/getting-started',
187+
link: '/guides/use-iapp/getting-started',
188188
},
189189
{
190190
text: 'Different Ways to Execute an iApp',
191-
link: '/guides/use-iapp/guides/different-ways-to-execute',
191+
link: '/guides/use-iapp/different-ways-to-execute',
192192
},
193193
{
194194
text: 'Add Inputs to the Execution',
195-
link: '/guides/use-iapp/guides/add-inputs-to-execution',
195+
link: '/guides/use-iapp/add-inputs-to-execution',
196196
},
197197
{
198198
text: 'Use iApp with Protected Data',
199-
link: '/guides/use-iapp/guides/use-iapp-with-protected-data',
199+
link: '/guides/use-iapp/use-iapp-with-protected-data',
200200
},
201201
{
202202
text: 'Find iApps to Use',
203-
link: '/guides/use-iapp/guides/find-iapps',
203+
link: '/guides/use-iapp/find-iapps',
204204
},
205205
{
206206
text: 'How to Pay the Executions',
207-
link: '/guides/use-iapp/guides/how-to-pay-executions',
207+
link: '/guides/use-iapp/how-to-pay-executions',
208208
},
209209
{
210210
text: '💰 How to Pay',
@@ -228,83 +228,13 @@ export function getSidebar() {
228228
},
229229
],
230230
},
231-
{
232-
text: '✉ Web3Mail',
233-
link: '/guides/use-iapp/web3mail',
234-
collapsed: true,
235-
items: [
236-
{
237-
text: 'Getting Started',
238-
link: '/guides/use-iapp/web3mail/getting-started',
239-
},
240-
{
241-
text: 'Methods',
242-
collapsed: true,
243-
items: [
244-
{
245-
text: 'fetchMyContacts',
246-
link: '/guides/use-iapp/web3mail/methods/fetchMyContacts',
247-
},
248-
{
249-
text: 'fetchUserContacts',
250-
link: '/guides/use-iapp/web3mail/methods/fetchUserContacts',
251-
},
252-
{
253-
text: 'sendEmail',
254-
link: '/guides/use-iapp/web3mail/methods/sendEmail',
255-
},
256-
],
257-
},
258-
{
259-
text: 'Advanced Configuration',
260-
link: '/guides/use-iapp/web3mail/advanced-configuration',
261-
},
262-
],
263-
},
264-
{
265-
text: '💬 Web3Telegram',
266-
link: '/guides/use-iapp/web3telegram',
267-
collapsed: true,
268-
items: [
269-
{
270-
text: 'Getting Started',
271-
link: '/guides/use-iapp/web3telegram/getting-started',
272-
},
273-
{
274-
text: 'Methods',
275-
collapsed: true,
276-
items: [
277-
{
278-
text: 'fetchMyContacts',
279-
link: '/guides/use-iapp/web3telegram/methods/fetchMyContacts',
280-
},
281-
{
282-
text: 'fetchUserContacts',
283-
link: '/guides/use-iapp/web3telegram/methods/fetchUserContacts',
284-
},
285-
{
286-
text: 'sendTelegram',
287-
link: '/guides/use-iapp/web3telegram/methods/sendTelegram',
288-
},
289-
],
290-
},
291-
{
292-
text: 'Integration Guide',
293-
link: '/guides/use-iapp/web3telegram/integration-guide',
294-
},
295-
{
296-
text: 'Advanced Configuration',
297-
link: '/guides/use-iapp/web3telegram/advanced-configuration',
298-
},
299-
],
300-
},
301231
],
302232
},
303233
],
304234
'/references/': [
305235
{
306236
text: '🔐 DataProtector',
307-
link: '/references/manage-data/dataProtector',
237+
link: '/references/dataProtector',
308238
collapsed: true,
309239
items: [
310240
{
@@ -534,33 +464,104 @@ export function getSidebar() {
534464
},
535465
{
536466
text: '🤖 iApp Generator',
537-
link: '/references/build-iapp/iapp-generator',
538-
collapsed: true,
467+
link: '/references/iapp-generator',
539468
items: [
540469
{
541470
text: 'Getting Started',
542-
link: '/references/build-iapp/iapp-generator/getting-started',
471+
link: '/references/iapp-generator/getting-started',
543472
},
544473
{
545474
text: 'Building your iApp',
546-
link: '/references/build-iapp/iapp-generator/building-your-iexec-app',
475+
link: '/references/iapp-generator/building-your-iexec-app',
547476
},
548477
{
549478
text: 'Deserialize ProtectedData',
550-
link: '/references/build-iapp/iapp-generator/deserializer',
479+
link: '/references/iapp-generator/deserializer',
551480
collapsed: true,
552481
items: [
553482
{
554483
text: 'getValue',
555-
link: '/references/build-iapp/iapp-generator/deserializer/getValue',
484+
link: '/references/iapp-generator/deserializer/getValue',
485+
},
486+
],
487+
},
488+
],
489+
},
490+
{
491+
text: '✉ Web3Mail',
492+
link: '/references/web3mail',
493+
items: [
494+
{
495+
text: 'Getting Started',
496+
link: '/references/web3mail/getting-started',
497+
},
498+
{
499+
text: 'Methods',
500+
collapsed: true,
501+
items: [
502+
{
503+
text: 'fetchMyContacts',
504+
link: '/references/web3mail/methods/fetchMyContacts',
505+
},
506+
{
507+
text: 'fetchUserContacts',
508+
link: '/references/web3mail/methods/fetchUserContacts',
509+
},
510+
{
511+
text: 'sendEmail',
512+
link: '/references/web3mail/methods/sendEmail',
513+
},
514+
],
515+
},
516+
{
517+
text: 'Advanced Configuration',
518+
link: '/references/web3mail/advanced-configuration',
519+
},
520+
],
521+
},
522+
{
523+
text: '💬 Web3Telegram',
524+
link: '/references/web3telegram',
525+
items: [
526+
{
527+
text: 'Getting Started',
528+
link: '/references/web3telegram/getting-started',
529+
},
530+
{
531+
text: 'Methods',
532+
collapsed: true,
533+
items: [
534+
{
535+
text: 'fetchMyContacts',
536+
link: '/references/web3telegram/methods/fetchMyContacts',
537+
},
538+
{
539+
text: 'fetchUserContacts',
540+
link: '/references/web3telegram/methods/fetchUserContacts',
541+
},
542+
{
543+
text: 'sendTelegram',
544+
link: '/references/web3telegram/methods/sendTelegram',
556545
},
557546
],
558547
},
548+
{
549+
text: 'Integration Guide',
550+
link: '/references/web3telegram/integration-guide',
551+
},
552+
{
553+
text: 'Advanced Configuration',
554+
link: '/references/web3telegram/advanced-configuration',
555+
},
559556
],
560557
},
558+
{
559+
text: '🔧 iExec SDK',
560+
link: '/references/sdk',
561+
},
561562
{
562563
text: '�📖 Glossary',
563-
link: '/references/protocol/glossary',
564+
link: '/references/glossary',
564565
},
565566
],
566567
} satisfies DefaultTheme.Sidebar;

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,7 @@ Fork this repository and ensure you're working on the `main` branch:
169169
- Update or add design illustrations based on the new design system
170170
- Check how to pay guide to update with the launch on Arbitrum (RLC vs xRLC)
171171
- framework AI supporté TDX vs SGX
172+
- check glossary
173+
- migrate github SDK doc here
174+
- migrate pay-per-task page into a guide
175+
- check pages (introduction & getting-started) for use-iapp guide

‎src/get-started/helloWorld/3-buildIApp.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ Here are some popular use cases:
5959
Send privacy-preserving emails to registered Ethereum account holders without
6060
knowing or storing their email addresses.
6161
[Github](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/dapp)
62-
| [Documentation](../../guides/use-iapp/web3mail)
62+
| [Documentation](/references/web3mail)
6363

6464
### 💬 Web3 Telegram
6565

6666
Send privacy-preserving Telegram messages without knowing or storing their
6767
Telegram handles.
6868
[Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp)
69-
| [Documentation](../../guides/use-iapp/web3telegram)
69+
| [Documentation](/references/web3telegram)
7070

7171
### 🌐 Content Delivery
7272

0 commit comments

Comments
 (0)