Skip to content

Commit ff6de2a

Browse files
committed
Introduce cookbook (updated init version)
Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
1 parent 771eb48 commit ff6de2a

File tree

3 files changed

+146
-1
lines changed

3 files changed

+146
-1
lines changed

.vitepress/config.mts

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,144 @@ function nav(): DefaultTheme.NavItem[] {
3535
link: '/reference/torii-endpoints',
3636
activeMatch: '/reference/',
3737
},
38+
{
39+
text: 'Cookbook',
40+
link: '/cookbook/',
41+
activeMatch: '/cookbook/',
42+
},
43+
]
44+
}
45+
46+
function sidebarCookbook(): DefaultTheme.SidebarItem[] {
47+
return [
48+
{
49+
text: 'Assets',
50+
collapsed: true,
51+
items: [
52+
{
53+
text: 'Work with Numeric Assets',
54+
},
55+
{
56+
text: 'Work with Store Assets',
57+
},
58+
{
59+
text: 'Transfer Assets Between Accounts',
60+
},
61+
{
62+
text: 'Mint More of a Mintable Asset',
63+
},
64+
{
65+
text: 'Work with Non-Mintable Assets',
66+
},
67+
{
68+
text: 'Create Asset-backed Tokens',
69+
},
70+
{
71+
text: 'Create Non-Fungible Tokens (NFTs)',
72+
},
73+
],
74+
},
75+
{
76+
text: 'Access Control',
77+
collapsed: true,
78+
items: [{
79+
text: 'Permissions',
80+
},
81+
{
82+
text: 'Roles',
83+
}],
84+
},
85+
{
86+
text: 'Metadata',
87+
collapsed: true,
88+
items: [
89+
{
90+
text: 'Set',
91+
},
92+
{
93+
text: 'Remove',
94+
},
95+
{
96+
text: 'Access',
97+
},
98+
],
99+
},
100+
{
101+
text: 'Events and Filters',
102+
collapsed: true,
103+
items: [
104+
{ text: 'Pipeline Events' },
105+
{ text: 'Data Events' },
106+
{ text: 'Trigger Events' },
107+
{ text: 'Advanced Filtering' },
108+
],
109+
},
110+
{
111+
text: 'Queries',
112+
collapsed: true,
113+
items: [
114+
{text: 'Use queries'},
115+
{text: 'Filter query results'},
116+
{text: 'Use Lazy Pagination'},
117+
{text: 'Query Connected Peers'},
118+
],
119+
},
120+
{
121+
text: 'Triggers',
122+
collapsed: true,
123+
items: [
124+
{
125+
text: 'Data Triggers',
126+
},
127+
{
128+
text: 'Time Triggers',
129+
},
130+
{
131+
text: 'By-call Triggers',
132+
},
133+
],
134+
},
135+
{
136+
text: 'Executor',
137+
collapsed: true,
138+
items: [
139+
{
140+
text: 'Write Executor'
141+
},
142+
{
143+
text: 'Update Executor',
144+
}
145+
],
146+
},
147+
{
148+
text: 'Block Stream',
149+
collapsed: true,
150+
items: [
151+
{text: 'Subscribe to Block Stream',},
152+
{text: 'View output'},
153+
],
154+
},
155+
{
156+
text: 'Telemetry',
157+
collapsed: true,
158+
items: [
159+
{
160+
text: 'Check Status',
161+
},
162+
{
163+
text: 'Work with Metrics',
164+
},
165+
],
166+
},
167+
{
168+
text: 'Miscellaneous',
169+
collapsed: true,
170+
items: [
171+
{ text: 'Transactions with Smartcontracts' },
172+
{ text: 'Multi-Signature Transactions (MSTs)' },
173+
{ text: 'Expressions' },
174+
],
175+
},
38176
]
39177
}
40178

@@ -481,6 +619,7 @@ export default defineConfig({
481619
sidebar: {
482620
'/guide/': sidebarGuide(),
483621
'/reference/': sidebarAPI(),
622+
'/cookbook/': sidebarCookbook(),
484623
},
485624

486625
search: {

src/cookbook/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cookbook
2+
3+
TODO

src/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,7 @@ features:
2323
title: Reference
2424
details: Consult reference documentation for extensive information about available functionality
2525
link: /reference/
26-
# - title: Cookbook # (TBA)
26+
- icon: 📓
27+
title: Cookbook
28+
details: Find code samples and example showcasing Iroha functionality
29+
link: /cookbook/

0 commit comments

Comments
 (0)