Skip to content

Commit bd1f09c

Browse files
Le-CaignecLe-Caignec
committed
refactor: update navigation and sidebar links for improved clarity and organization; add new glossary, SDK, and workers documentation
1 parent c9ad91e commit bd1f09c

File tree

8 files changed

+105
-54
lines changed

8 files changed

+105
-54
lines changed

‎.vitepress/config.mts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,11 @@ export default defineConfig({
8484
themeConfig: {
8585
// https://vitepress.dev/reference/default-theme-config
8686
nav: [
87-
{ text: 'Home', link: '/' },
88-
{ text: 'Protect Data', link: '/manage-data/guides' },
87+
{ text: 'Overview', link: '/overview/what-we-do' },
88+
{ text: 'Protect Data', link: '/manage-data/what-is-protected-data' },
8989
{ text: 'Build iApp', link: '/build-iapp/what-is-iapp' },
9090
{ text: 'Use iApp', link: '/use-iapp/introduction' },
91+
{ text: 'Core Concept', link: '/core-concept/glossary' },
9192
],
9293
outline: {
9394
level: [2, 3],

‎.vitepress/sidebar.ts‎

Lines changed: 101 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ export function getSidebar() {
66
{
77
text: 'OVERVIEW',
88
items: [
9-
{ text: '💡  What We Do', link: '/overview/what-we-do' },
9+
{ text: '💡 What We Do', link: '/overview/what-we-do' },
1010
{
11-
text: '👋   Hello World',
11+
text: '👋 Hello World',
1212
link: '/overview/helloWorld',
1313
collapsed: true,
1414
items: [
@@ -20,10 +20,7 @@ export function getSidebar() {
2020
text: 'Protect data',
2121
link: '/overview/helloWorld/2-protectData',
2222
},
23-
{
24-
text: 'Build iApp',
25-
link: '/overview/helloWorld/3-buildIApp',
26-
},
23+
{ text: 'Build iApp', link: '/overview/helloWorld/3-buildIApp' },
2724
{
2825
text: 'Manage data access',
2926
link: '/overview/helloWorld/4-manageDataAccess',
@@ -35,13 +32,10 @@ export function getSidebar() {
3532
],
3633
},
3734
{
38-
text: '📋  Use Cases',
35+
text: '📋 Use Cases',
3936
collapsed: true,
4037
items: [
41-
{
42-
text: 'AI',
43-
link: '/overview/use-cases/ai',
44-
},
38+
{ text: 'AI', link: '/overview/use-cases/ai' },
4539
{
4640
text: 'Other Emerging Trends',
4741
link: '/overview/use-cases/other-emerging-trends',
@@ -64,24 +58,86 @@ export function getSidebar() {
6458
],
6559
},
6660
{
67-
text: '🤖  Use the docs in your AI',
61+
text: '🤖 Use the docs in your AI',
6862
link: '/overview/ai-integration',
6963
},
64+
{ text: '🆘 Contact Us', link: '/overview/contact-us' },
65+
],
66+
},
67+
],
68+
'/overview/': [
69+
{
70+
text: 'OVERVIEW',
71+
items: [
72+
{ text: '💡 What We Do', link: '/overview/what-we-do' },
7073
{
71-
text: '🆘  Contact Us',
72-
link: '/overview/contact-us',
74+
text: '👋 Hello World',
75+
link: '/overview/helloWorld',
76+
collapsed: true,
77+
items: [
78+
{
79+
text: 'iExec Overview',
80+
link: '/overview/helloWorld/1-overview',
81+
},
82+
{
83+
text: 'Protect data',
84+
link: '/overview/helloWorld/2-protectData',
85+
},
86+
{ text: 'Build iApp', link: '/overview/helloWorld/3-buildIApp' },
87+
{
88+
text: 'Manage data access',
89+
link: '/overview/helloWorld/4-manageDataAccess',
90+
},
91+
{
92+
text: 'Bonus chapter!',
93+
link: '/overview/helloWorld/5-bonusChapter',
94+
},
95+
],
7396
},
97+
{
98+
text: '📋 Use Cases',
99+
collapsed: true,
100+
items: [
101+
{ text: 'AI', link: '/overview/use-cases/ai' },
102+
{
103+
text: 'Other Emerging Trends',
104+
link: '/overview/use-cases/other-emerging-trends',
105+
},
106+
{
107+
text: 'Use Case Demos',
108+
link: '/overview/use-case-demo',
109+
collapsed: true,
110+
items: [
111+
{
112+
text: 'Content Creator',
113+
link: '/overview/use-case-demo/content-creator',
114+
},
115+
{
116+
text: 'Web3 Messaging',
117+
link: '/overview/use-case-demo/web3messaging',
118+
},
119+
],
120+
},
121+
],
122+
},
123+
{
124+
text: '🤖 Use the docs in your AI',
125+
link: '/overview/ai-integration',
126+
},
127+
{ text: '🆘 Contact Us', link: '/overview/contact-us' },
74128
],
75129
},
130+
],
131+
'/manage-data/': [
76132
{
77133
text: 'PROTECT AND MANAGE DATA',
78134
items: [
79135
{
80-
text: '❓  What Is Protected Data?',
81-
link: '/manage-data/dataProtector/what-is-protected-data',
136+
text: '❓ What Is Protected Data?',
137+
link: '/manage-data/what-is-protected-data',
82138
},
83139
{
84-
text: '📖  Guides',
140+
text: '📖 Guides',
85141
link: '/manage-data/guides',
86142
collapsed: true,
87143
items: [
@@ -100,14 +156,18 @@ export function getSidebar() {
100156
],
101157
},
102158
{
103-
text: '🔐&nbsp;&nbsp;DataProtector <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">beta</span>',
159+
text: '🔐 DataProtector',
104160
link: '/manage-data/dataProtector',
105161
collapsed: true,
106162
items: [
107163
{
108164
text: 'Getting Started',
109165
link: '/manage-data/dataProtector/getting-started',
110166
},
167+
{
168+
text: 'Guides',
169+
link: '/manage-data/dataProtector/guides',
170+
},
111171
{
112172
text: 'DataProtector Core',
113173
link: '/manage-data/dataProtector/dataProtectorCore',
@@ -349,15 +409,15 @@ export function getSidebar() {
349409
},
350410
],
351411
},
412+
],
413+
'/build-iapp/': [
352414
{
353415
text: 'BUILD YOUR iAPP',
354416
items: [
417+
{ text: '❓ What Is an iApp?', link: '/build-iapp/what-is-iapp' },
355418
{
356-
text: '❓&nbsp;&nbsp;What Is an iApp?',
357-
link: '/build-iapp/what-is-iapp',
358-
},
359-
{
360-
text: '📖&nbsp;&nbsp;Guides',
419+
text: '📖 Guides',
420+
link: '/build-iapp/guides',
361421
collapsed: true,
362422
items: [
363423
{
@@ -395,7 +455,7 @@ export function getSidebar() {
395455
],
396456
},
397457
{
398-
text: '🤖&nbsp;&nbsp;iApp Generator',
458+
text: '🤖 iApp Generator',
399459
link: '/build-iapp/iapp-generator',
400460
collapsed: true,
401461
items: [
@@ -418,24 +478,21 @@ export function getSidebar() {
418478
],
419479
},
420480
{
421-
text: '🔧&nbsp;&nbsp;Protocol-Level Guides',
481+
text: '🔧 Protocol-Level Guides',
422482
link: '/build-iapp/iapp-generator/protocol-level-guides',
423483
},
424484
],
425485
},
486+
],
487+
'/use-iapp/': [
426488
{
427489
text: 'USE AN iAPP',
428490
items: [
491+
{ text: '📝 Introduction', link: '/use-iapp/introduction' },
492+
{ text: '🚀 Getting Started', link: '/use-iapp/getting-started' },
429493
{
430-
text: '📝&nbsp;&nbsp;Introduction',
431-
link: '/use-iapp/introduction',
432-
},
433-
{
434-
text: '🚀&nbsp;&nbsp;Getting Started',
435-
link: '/use-iapp/getting-started',
436-
},
437-
{
438-
text: '📖&nbsp;&nbsp;Guides',
494+
text: '📖 Guides',
495+
link: '/use-iapp/guides',
439496
collapsed: true,
440497
items: [
441498
{
@@ -461,7 +518,7 @@ export function getSidebar() {
461518
],
462519
},
463520
{
464-
text: '💰&nbsp;&nbsp;How to Pay',
521+
text: '💰 How to Pay',
465522
link: '/use-iapp/payment',
466523
collapsed: true,
467524
items: [
@@ -484,7 +541,7 @@ export function getSidebar() {
484541
],
485542
},
486543
{
487-
text: '✉&nbsp;&nbsp;Web3Mail',
544+
text: '✉ Web3Mail',
488545
link: '/use-iapp/web3mail',
489546
collapsed: true,
490547
items: [
@@ -517,7 +574,7 @@ export function getSidebar() {
517574
],
518575
},
519576
{
520-
text: '💬&nbsp;&nbsp;Web3Telegram <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">alpha</span>',
577+
text: '💬 Web3Telegram <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">alpha</span>',
521578
link: '/use-iapp/web3telegram',
522579
collapsed: true,
523580
items: [
@@ -554,7 +611,7 @@ export function getSidebar() {
554611
],
555612
},
556613
{
557-
text: '🧙&nbsp;&nbsp;Oracle Factory',
614+
text: '🧙 Oracle Factory',
558615
link: '/use-iapp/oracle-factory',
559616
collapsed: true,
560617
items: [
@@ -588,21 +645,14 @@ export function getSidebar() {
588645
},
589646
],
590647
},
648+
],
649+
'/core-concept/': [
591650
{
592-
text: 'KEY CONCEPTS',
651+
text: 'CORE CONCEPTS',
593652
items: [
594-
{
595-
text: '🔧&nbsp;&nbsp;iExec SDK',
596-
link: '/deep-dive/sdk',
597-
},
598-
{
599-
text: '⚙️&nbsp;&nbsp;Workers & Workerpools',
600-
link: '/deep-dive/workers',
601-
},
602-
{
603-
text: '📖&nbsp;&nbsp;Glossary',
604-
link: '/deep-dive/glossary',
605-
},
653+
{ text: '🔧 iExec SDK', link: '/core-concept/sdk' },
654+
{ text: '⚙️ Workers & Workerpools', link: '/core-concept/workers' },
655+
{ text: '📖 Glossary', link: '/core-concept/glossary' },
606656
],
607657
},
608658
],

src/deep-dive/glossary.md renamed to src/core-concept/glossary.md

File renamed without changes.

src/deep-dive/sdk.md renamed to src/core-concept/sdk.md

File renamed without changes.

src/deep-dive/workers.md renamed to src/core-concept/workers.md

File renamed without changes.

‎src/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ features:
3838
- icon: 🔧
3939
title: Developer Tools
4040
details: Access comprehensive SDKs, APIs, and tools to integrate with the iExec ecosystem
41-
link: /deep-dive/sdk
41+
link: /core-concept/sdk
4242
---

src/manage-data/dataProtector/what-is-protected-data.md renamed to src/manage-data/what-is-protected-data.md

File renamed without changes.

src/manage-data/intro.md renamed to src/use-iapp/guides.md

File renamed without changes.

0 commit comments

Comments
 (0)