Skip to content

Commit 1b2cca8

Browse files
outoftardisoutoftardis
committed
Introduce cookbook (updated init version)
Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
1 parent 12fc601 commit 1b2cca8

File tree

3 files changed

+301
-1
lines changed

3 files changed

+301
-1
lines changed

‎.vitepress/config.mts‎

Lines changed: 294 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,299 @@ 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: 'Access Control',
50+
collapsed: true,
51+
items: [
52+
{
53+
text: 'Permission Tokens',
54+
collapsed: true,
55+
items: [],
56+
},
57+
{
58+
text: 'Roles',
59+
collapsed: true,
60+
items: [
61+
{
62+
text: 'Register a Role',
63+
},
64+
{
65+
text: 'Grant a Role',
66+
},
67+
{
68+
text: 'Revoke a Role',
69+
},
70+
],
71+
},
72+
{
73+
text: 'Executors (Permission Validators)',
74+
collapsed: true,
75+
items: [
76+
{
77+
text: 'Write Executor',
78+
},
79+
{
80+
text: 'Update Executor',
81+
}
82+
],
83+
}
84+
],
85+
},
86+
{
87+
text: 'Accounts',
88+
collapsed: true,
89+
items: [
90+
{
91+
text: 'Register Accounts',
92+
},
93+
{
94+
text: 'Unregister Accounts',
95+
},
96+
{
97+
text: 'Update Account Metadata'
98+
},
99+
// ...
100+
],
101+
},
102+
{
103+
text: 'Assets',
104+
collapsed: true,
105+
items: [
106+
{
107+
text: 'Assets', // All Assets?
108+
collapsed: true,
109+
items: [
110+
{
111+
text: 'Register Assets',
112+
},
113+
{
114+
text: 'Unregister Assets',
115+
},
116+
{
117+
text: 'Transfer Assets Between Accounts',
118+
},
119+
],
120+
},
121+
{
122+
text: 'Numeric Assets',
123+
collapsed: true,
124+
items: [],
125+
},
126+
{
127+
text: 'Store Assets',
128+
collapsed: true,
129+
items: [],
130+
},
131+
{
132+
text: 'Mintable Assets',
133+
collapsed: true,
134+
items: [
135+
{
136+
text: 'Mint Assets',
137+
},
138+
{
139+
text: 'Mint More of a Mintable Asset',
140+
},
141+
{
142+
text: 'Burn Assets',
143+
},
144+
],
145+
},
146+
{
147+
text: 'Non-Mintable Assets',
148+
collapsed: true,
149+
items: [
150+
{
151+
text: 'Work with Non-Mintable Assets',
152+
},
153+
],
154+
},
155+
{
156+
text: 'Tokens',
157+
collapsed: true,
158+
items: [
159+
{
160+
text: 'Create Asset-backed Tokens',
161+
},
162+
{
163+
text: 'Create Non-Fungible Tokens (NFTs)',
164+
},
165+
],
166+
},
167+
],
168+
},
169+
{
170+
text: 'Domains',
171+
collapsed: true,
172+
items: [
173+
{
174+
text: 'Register Domains',
175+
},
176+
{
177+
text: 'Update Domain Metadata',
178+
},
179+
// ...
180+
// access management for domains
181+
],
182+
},
183+
{
184+
text: 'Events and Filters',
185+
collapsed: true,
186+
items: [
187+
{
188+
text: 'Pipeline Events',
189+
collapsed: true,
190+
items: [],
191+
},
192+
{
193+
text: 'Data Events',
194+
collapsed: true,
195+
items: [],
196+
},
197+
{
198+
text: 'Trigger Events',
199+
collapsed: true,
200+
items: [],
201+
},
202+
{
203+
text: 'Advanced Filtering',
204+
collapsed: true,
205+
items: [],
206+
},
207+
{
208+
text: 'Block Stream',
209+
collapsed: true,
210+
items: [
211+
{
212+
text: 'Subscribe to Block Stream',
213+
},
214+
{
215+
text: 'View output',
216+
},
217+
],
218+
},
219+
],
220+
},
221+
{
222+
text: 'Instructions',
223+
collapsed: true,
224+
items: [
225+
{
226+
text: 'Use instructions',
227+
},
228+
{
229+
text: 'Combine Instructions via Expressions',
230+
},
231+
],
232+
},
233+
{
234+
text: 'Metadata',
235+
collapsed: true,
236+
items: [
237+
{
238+
text: 'Set Key Value',
239+
},
240+
{
241+
text: 'Remove Key Value',
242+
},
243+
{
244+
text: 'Access Metadata',
245+
},
246+
],
247+
},
248+
{
249+
text: 'Peers',
250+
collapsed: true,
251+
items: [
252+
{
253+
text: 'Register Peers',
254+
},
255+
{
256+
text: "Check Current Peer's Load",
257+
},
258+
{
259+
text: 'Find the Leader Among Running Peers',
260+
},
261+
],
262+
},
263+
{
264+
text: 'Queries',
265+
collapsed: true,
266+
items: [
267+
{text: 'Use queries'},
268+
{text: 'Filter query results'},
269+
{text: 'Use Lazy Pagination'},
270+
{text: 'Query Connected Peers'},
271+
],
272+
},
273+
{
274+
text: 'Telemetry',
275+
collapsed: true,
276+
items: [
277+
{
278+
text: 'Check Status',
279+
},
280+
{
281+
text: 'Get Metrics',
282+
},
283+
{
284+
text: 'Monitor Iroha Performance',
285+
},
286+
{
287+
text: 'Check Health',
288+
},
289+
],
290+
},
291+
{
292+
text: 'Transactions',
293+
collapsed: true,
294+
items: [
295+
{
296+
text: 'Create Transactions',
297+
},
298+
{
299+
text: 'Submit Transactions',
300+
},
301+
{
302+
text: 'Compile Transactions',
303+
},
304+
{
305+
text: 'Use Multi-Signature Transactions',
306+
},
307+
],
308+
},
309+
{
310+
text: 'Triggers',
311+
collapsed: true,
312+
items: [
313+
{
314+
text: 'Data Triggers',
315+
collapsed: true,
316+
items: [],
317+
},
318+
{
319+
text: 'Time Triggers',
320+
collapsed: true,
321+
items: [],
322+
},
323+
{
324+
text: 'By-call Triggers',
325+
collapsed: true,
326+
items: [],
327+
},
328+
],
329+
},
330+
38331
]
39332
}
40333

@@ -481,6 +774,7 @@ export default defineConfig({
481774
sidebar: {
482775
'/guide/': sidebarGuide(),
483776
'/reference/': sidebarAPI(),
777+
'/cookbook/': sidebarCookbook(),
484778
},
485779

486780
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/torii-endpoints
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)