Skip to content

Commit

Permalink
Introduce cookbook (updated init version)
Browse files Browse the repository at this point in the history
Signed-off-by: Ekaterina Mekhnetsova <[email protected]>
  • Loading branch information
outoftardis committed Nov 2, 2023
1 parent 771eb48 commit ff6de2a
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 1 deletion.
139 changes: 139 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,144 @@ function nav(): DefaultTheme.NavItem[] {
link: '/reference/torii-endpoints',
activeMatch: '/reference/',
},
{
text: 'Cookbook',
link: '/cookbook/',
activeMatch: '/cookbook/',
},
]
}

function sidebarCookbook(): DefaultTheme.SidebarItem[] {
return [
{
text: 'Assets',
collapsed: true,
items: [
{
text: 'Work with Numeric Assets',
},
{
text: 'Work with Store Assets',
},
{
text: 'Transfer Assets Between Accounts',
},
{
text: 'Mint More of a Mintable Asset',
},
{
text: 'Work with Non-Mintable Assets',
},
{
text: 'Create Asset-backed Tokens',
},
{
text: 'Create Non-Fungible Tokens (NFTs)',
},
],
},
{
text: 'Access Control',
collapsed: true,
items: [{
text: 'Permissions',
},
{
text: 'Roles',
}],
},
{
text: 'Metadata',
collapsed: true,
items: [
{
text: 'Set',
},
{
text: 'Remove',
},
{
text: 'Access',
},
],
},
{
text: 'Events and Filters',
collapsed: true,
items: [
{ text: 'Pipeline Events' },
{ text: 'Data Events' },
{ text: 'Trigger Events' },
{ text: 'Advanced Filtering' },
],
},
{
text: 'Queries',
collapsed: true,
items: [
{text: 'Use queries'},
{text: 'Filter query results'},
{text: 'Use Lazy Pagination'},
{text: 'Query Connected Peers'},
],
},
{
text: 'Triggers',
collapsed: true,
items: [
{
text: 'Data Triggers',
},
{
text: 'Time Triggers',
},
{
text: 'By-call Triggers',
},
],
},
{
text: 'Executor',
collapsed: true,
items: [
{
text: 'Write Executor'
},
{
text: 'Update Executor',
}
],
},
{
text: 'Block Stream',
collapsed: true,
items: [
{text: 'Subscribe to Block Stream',},
{text: 'View output'},
],
},
{
text: 'Telemetry',
collapsed: true,
items: [
{
text: 'Check Status',
},
{
text: 'Work with Metrics',
},
],
},
{
text: 'Miscellaneous',
collapsed: true,
items: [
{ text: 'Transactions with Smartcontracts' },
{ text: 'Multi-Signature Transactions (MSTs)' },
{ text: 'Expressions' },
],
},
]
}

Expand Down Expand Up @@ -481,6 +619,7 @@ export default defineConfig({
sidebar: {
'/guide/': sidebarGuide(),
'/reference/': sidebarAPI(),
'/cookbook/': sidebarCookbook(),
},

search: {
Expand Down
3 changes: 3 additions & 0 deletions src/cookbook/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Cookbook

TODO
5 changes: 4 additions & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,7 @@ features:
title: Reference
details: Consult reference documentation for extensive information about available functionality
link: /reference/
# - title: Cookbook # (TBA)
- icon: 📓
title: Cookbook
details: Find code samples and example showcasing Iroha functionality
link: /cookbook/

0 comments on commit ff6de2a

Please sign in to comment.