Introduce cookbook (updated init version)

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>
hyperledger-iroha · Nov 2, 2023 · a218531 · a218531
1 parent 771eb48
commit a218531
Show file tree

Hide file tree

Showing 3 changed files with 158 additions and 1 deletion.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -35,6 +35,156 @@ 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',
+        },
+      ],
+    },
   ]
 }
 
@@ -481,6 +631,7 @@ export default defineConfig({
     sidebar: {
       '/guide/': sidebarGuide(),
       '/reference/': sidebarAPI(),
+      '/cookbook/': sidebarCookbook(),
     },
 
     search: {

diff --git a/src/cookbook/index.md b/src/cookbook/index.md
@@ -0,0 +1,3 @@
+# Cookbook
+
+TODO
diff --git a/src/index.md b/src/index.md
@@ -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/