Skip to content

Commit 68a62ae

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

File tree

3 files changed

+341
-1
lines changed

3 files changed

+341
-1
lines changed

‎.vitepress/config.mts‎

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

@@ -481,6 +814,7 @@ export default defineConfig({
481814
sidebar: {
482815
'/guide/': sidebarGuide(),
483816
'/reference/': sidebarAPI(),
817+
'/cookbook/': sidebarCookbook(),
484818
},
485819

486820
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)