Skip to content

Introduce Cookbook #424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
+2,011 −3
Open

Introduce Cookbook #424

Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b5c440b
Introduce cookbook (updated init version)
outoftardis Nov 2, 2023
ea2c326
Update .vitepress/config.mts
outoftardis Nov 16, 2023
ffd86e1
Update .vitepress/config.mts
outoftardis Nov 16, 2023
a4c58a7
Update .vitepress/config.mts
outoftardis Nov 16, 2023
9f5abbc
Update .vitepress/config.mts
outoftardis Nov 16, 2023
64b80f7
Update .vitepress/config.mts
outoftardis Nov 16, 2023
9555936
Update .vitepress/config.mts
outoftardis Nov 16, 2023
a6e80fb
Update .vitepress/config.mts
outoftardis Nov 21, 2023
772e30f
Address comments
outoftardis Nov 21, 2023
d227ba1
Remove comments
outoftardis Nov 21, 2023
5dd9d21
Fix formatting
outoftardis Nov 21, 2023
c1738e2
Add files with metadata
outoftardis Nov 23, 2023
cd28f8f
Fix format
outoftardis Nov 23, 2023
60f5874
Apply suggestions from code review
outoftardis Nov 24, 2023
778d8a3
Add a topic
outoftardis Nov 30, 2023
e2df86c
[docs]: add MST draft
0x009922 Dec 4, 2023
cbd941b
Apply suggestions from code review
0x009922 Dec 7, 2023
90a4e7e
[docs]: refine MST recipe
0x009922 Dec 7, 2023
951c9db
ADD: Few examples
Stukalov-A-M Jan 20, 2024
619c0e8
ADD: burn-assets.md, submit-transactions.md
Stukalov-A-M Jan 21, 2024
9fa9e2e
EDIT: Indents are removed
Stukalov-A-M Jan 22, 2024
b59603f
Merge pull request #1 from Stukalov-A-M/pr424
0x009922 Jan 26, 2024
6d4ff5d
[ADD]: access-metadata, check-status, combine-instructions, create-tr…
Stukalov-A-M Jan 29, 2024
1fd5958
[ADD]: register-domains, unregister-asset-def, unregister-assets, unr…
Stukalov-A-M Feb 9, 2024
a4af32b
[ADD]: unregister-accounts
Stukalov-A-M Feb 9, 2024
1551872
[add]: register-roles, use-instructions, work-with-numeric-assets
nxsaken Apr 10, 2024
9ebde90
[add]: grant-permissions, grant-roles
nxsaken Apr 11, 2024
e7f8ab7
[add]: work-with-non-mintable-assets
nxsaken Apr 16, 2024
1763b34
[add]: revoke-permissions, revoke-roles, transfer-assets, work-with-s…
nxsaken Apr 16, 2024
bc1a100
[edit]: edit existing entries to match newer examples, replace some o…
nxsaken Apr 17, 2024
8de8655
[add]: transfer-group-assets
nxsaken Apr 18, 2024
7145cbb
Address feedback
nxsaken May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
376 changes: 375 additions & 1 deletion .vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,379 @@ function nav(): DefaultTheme.NavItem[] {
link: '/reference/torii-endpoints',
activeMatch: '/reference/',
},
{
text: 'Cookbook',
link: '/cookbook/',
activeMatch: '/cookbook/',
},
]
}

function sidebarCookbook(): DefaultTheme.SidebarItem[] {
return [
{
text: 'Access Control',
collapsed: true,
items: [
{
text: 'Permission Tokens',
collapsed: true,
items: [
{
text: 'Grant Permissions',
link: '/cookbook/grant-permissions',
},
{
text: 'Revoke Permissions',
link: '/cookbook/revoke-permissions',
},
],
},
{
text: 'Roles',
collapsed: true,
items: [
{
text: 'Register a Role',
link: '/cookbook/register-roles',
},
{
text: 'Grant a Role',
link: '/cookbook/grant-roles',
},
{
text: 'Revoke a Role',
link: '/cookbook/revoke-roles',
},
],
},
],
},
{
text: 'Accounts',
collapsed: true,
items: [
{
text: 'Register Accounts',
link: '/cookbook/register-accounts',
},
{
text: 'Unregister Accounts',
link: '/cookbook/unregister-accounts',
},
],
},
{
text: 'Asset Definitions',
collapsed: true,
items: [
{
text: 'Register Asset Definitions',
link: '/cookbook/register-asset-definitions',
},
{
text: 'Unregister Asset Definitions',
link: '/cookbook/unregister-asset-definitions',
},
{
text: 'Transfer Asset Definitions',
link: '/cookbook/transfer-asset-definitions',
},
],
},
{
text: 'Assets',
collapsed: true,
items: [
{
text: 'Assets',
collapsed: true,
items: [
{
text: 'Register Assets',
link: '/cookbook/register-assets',
},
{
text: 'Unregister Assets',
link: '/cookbook/unregister-assets',
},
{
text: 'Transfer Assets Between Accounts',
link: '/cookbook/transfer-assets',
},
{
text: 'Transfer Groups of Assets',
link: '/cookbook/transfer-group-assets',
},
],
},
{
text: 'Numeric Assets',
collapsed: true,
items: [
{
text: 'Work with Numeric Assets',
link: '/cookbook/work-with-numeric-assets',
},
],
},
{
text: 'Store Assets',
collapsed: true,
items: [
{
text: 'Work with Store Assets',
link: '/cookbook/work-with-store-assets',
},
],
},
{
text: 'Mintable Assets',
collapsed: true,
items: [
{
text: 'Mint Assets',
link: '/cookbook/mint-assets',
},
{
text: 'Mint More of a Mintable Asset',
link: '/cookbook/mint-more-assets',
},
{
text: 'Burn Assets',
link: '/cookbook/burn-assets',
},
],
},
{
text: 'Non-Mintable Assets',
collapsed: true,
items: [
{
text: 'Work with Non-Mintable Assets',
link: '/cookbook/work-with-non-mintable-assets',
},
],
},
{
text: 'Tokens',
collapsed: true,
items: [
{
text: 'Create Asset-backed Tokens',
link: '/cookbook/create-asset-backed-tokens',
},
{
text: 'Create Non-Fungible Tokens (NFTs)',
link: '/cookbook/create-nfts',
},
],
},
],
},
{
text: 'Domains',
collapsed: true,
items: [
{
text: 'Register Domains',
link: '/cookbook/register-domains',
},
{
text: 'Unregister Domains',
link: '/cookbook/unregister-domains',
},
{
text: 'Transfer Domain Owner',
link: '/cookbook/transfer-domain-owner',
},
],
},
{
text: 'Events and Filters', // for this sections no files were created
collapsed: true,
items: [
{
text: 'Pipeline Events',
collapsed: true,
items: [],
},
{
text: 'Data Events',
collapsed: true,
items: [],
},
{
text: 'Trigger Events',
collapsed: true,
items: [],
},
{
text: 'Advanced Filtering',
collapsed: true,
items: [],
},
{
text: 'Block Stream',
collapsed: true,
items: [
{
text: 'Subscribe to Block Stream',
},
{
text: 'View output',
},
],
},
],
},
{
text: 'Executors',
collapsed: true,
items: [
{
text: 'Write Executor',
link: '/cookbook/write-executor',
},
{
text: 'Update Executor',
link: '/cookbook/update-executor',
},
{
text: 'Define Custom Permission Tokens',
link: '/cookbook/define-custom-permission-tokens',
},
],
},
{
text: 'Instructions',
collapsed: true,
items: [
{
text: 'Use Instructions',
link: '/cookbook/use-instructions',
},
{
text: 'Combine Instructions via Expressions',
link: '/cookbook/combine-instructions',
},
],
},
{
text: 'Metadata',
collapsed: true,
items: [
{
text: 'Set Key Value',
link: '/cookbook/set-key-value',
},
{
text: 'Remove Key Value',
link: '/cookbook/remove-key-value',
},
{
text: 'Access Metadata',
link: '/cookbook/access-metadata',
},
],
},
{
text: 'Peers',
collapsed: true,
items: [
{
text: 'Register Peers',
link: '/cookbook/register-peers',
},
{
text: 'Unregister Peers',
link: '/cookbook/unregister-peers',
},
{
text: "Check Peer's Load",
link: '/cookbook/check-peer-load',
},
{
text: 'Find the Leader Among Running Peers',
link: '/cookbook/find-leader-among-running-peers',
},
{
text: 'Query Connected Peers',
link: '/cookbook/query-connected-peers',
},
],
},
{
text: 'Queries',
collapsed: true,
items: [{ text: 'Use queries' }, { text: 'Filter query results' }, { text: 'Use Sorting and Pagination' }],
},
{
text: 'Telemetry',
collapsed: true,
items: [
{
text: 'Check Status',
link: '/cookbook/check-status',
},
{
text: 'Get Metrics',
link: '/cookbook/get-metrics',
},
{
text: 'Monitor Iroha Performance',
link: '/cookbook/monitor-iroha-performance',
},
{
text: 'Check Health',
link: '/cookbook/check-health',
},
],
},
{
text: 'Transactions',
collapsed: true,
items: [
{
text: 'Create Transactions',
link: '/cookbook/create-transactions',
},
{
text: 'Submit Transactions',
link: '/cookbook/submit-transactions',
},
{
text: 'Use Multi-Signature Transactions',
link: '/cookbook/use-multi-signature-transactions',
},
],
},
{
text: 'Triggers',
collapsed: true,
items: [
{
text: 'Register a Data Trigger',
link: '/cookbook/register-data-triggers',
},
{
text: 'Register a Scheduled Trigger',
link: '/cookbook/register-scheduled-triggers',
},
{
text: 'Register a Pre-commit Trigger',
link: '/cookbook/register-pre-commit-triggers',
},
{
text: 'Register a By-call Trigger',
link: '/cookbook/register-by-call-triggers',
},
{
text: 'Unregister a Trigger',
link: '/cookbook/unregister-triggers',
},
],
},
]
}

Expand Down Expand Up @@ -405,7 +778,7 @@ export default defineConfig({
base: BASE,
srcDir: 'src',
srcExclude: ['snippets/*.md'],
title: 'Hyperledger Iroha 2 Tutorial',
title: 'Hyperledger Iroha 2 Documentation',
description:
'Documentation for Hyperledger Iroha 2 offering step-by-step guides for SDKs and outlining the main differences between Iroha versions.',
lang: 'en-US',
Expand Down Expand Up @@ -481,6 +854,7 @@ export default defineConfig({
sidebar: {
'/guide/': sidebarGuide(),
'/reference/': sidebarAPI(),
'/cookbook/': sidebarCookbook(),
},

search: {
Expand Down
Loading