From dcefe94471813e0a5f4aed94944557774835b484 Mon Sep 17 00:00:00 2001 From: dragosrebegea Date: Wed, 17 Apr 2024 11:04:25 +0300 Subject: [PATCH] new-proposed-structure --- sidebars.js | 558 ++++++++++------------------------------------------ 1 file changed, 105 insertions(+), 453 deletions(-) diff --git a/sidebars.js b/sidebars.js index 61e8a7179..6df848c2c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,468 +1,120 @@ /** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. + * Revised sidebar configuration for the MultiversX documentation, + * designed to help new developers navigate the learning resources effectively. */ // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - // tutorialSidebar: [{ type: "autogenerated", dirName: "." }], - - // But you can create a sidebar manually - /* tutorialSidebar: [ - 'intro', - 'hello', { type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + label: 'Getting Started', + items: [ + 'welcome/welcome-to-multiversx', + 'technology/architecture-overview', + 'technology/glossary', + 'technology/entities', + 'technology/chronology', + 'setup/installing-mxpy', + 'setup/configuring-mxpy', + 'setup/cli-overview', + 'setup/build-reference', + 'setup/configuration', + ], + }, + { + type: 'category', + label: 'Core Blockchain Concepts', + items: [ + 'blockchain-basics/secure-proof-of-stake', + 'blockchain-basics/adaptive-state-sharding', + 'smart-contracts/smart-contracts-overview', + 'smart-contracts/multiversx-smart-contracts', + 'smart-contracts/smart-contract-api-functions', + 'smart-contracts/smart-contract-annotations', + 'smart-contracts/smart-contract-modules', + 'smart-contracts/upgrading-smart-contracts', + ], + }, + { + type: 'category', + label: 'Development Tools and SDKs', + items: [ + 'development-tools/sdks-overview', + 'development-tools/python-sdk', + 'development-tools/javascript-sdk', + 'development-tools/nestjs-sdk', + 'development-tools/go-sdk', + 'development-tools/java-sdk', + 'development-tools/cplusplus-sdk', + 'development-tools/kotlin-sdk', + 'development-tools/tooling-overview', + 'development-tools/smart-contract-debugging', + 'development-tools/rust-testing-framework', + 'development-tools/memory-allocation', + 'development-tools/rust-nightly', + ], + }, + { + type: 'category', + label: 'Building Applications', + items: [ + 'building-applications/your-first-dapp', + 'building-applications/your-first-microservice', + 'building-applications/crowdfunding-p1', + 'building-applications/crowdfunding-p2', + 'building-applications/counter', + 'building-applications/staking-contract', + 'building-applications/advanced-smart-contract-features/smart-contract-payments', + 'building-applications/advanced-smart-contract-features/smart-contract-calls', + 'building-applications/advanced-smart-contract-features/storage-mappers', + 'building-applications/advanced-smart-contract-features/random-numbers', + ], + }, + { + type: 'category', + label: 'Transaction Management and Testing', + items: [ + 'transaction-management/signing-transactions', + 'transaction-management/smart-contract-call-events', + 'transaction-management/esdt-operations-events', + 'transaction-management/testing-overview', + 'transaction-management/running-scenarios', + 'transaction-management/network-and-infrastructure/localnet-setup', + 'transaction-management/network-and-infrastructure/blockchain-operations', + 'transaction-management/network-and-infrastructure/node-operation-modes', + 'transaction-management/network-and-infrastructure/managing-a-validator-node', + ], + }, + { + type: 'category', + label: 'Integration and Advanced Topics', + items: [ + 'integration/integrate-egld', + 'integration/esdt-tokens-integration-guide', + 'integration/host-multiversx-infrastructure', + 'integration/ad-astra-bridge-architecture', + 'integration/validator-and-staking-management/validators-overview', + 'integration/validator-and-staking-management/staking-v4', + 'integration/validator-and-staking-management/the-delegation-manager', + 'integration/validator-and-staking-management/node-cli', + ], + }, + { + type: 'category', + label: 'Additional Resources and Support', + items: [ + 'additional-resources/faqs', + 'additional-resources/fix-rust-installation', + 'additional-resources/multiversx-tools-on-multiple-platforms', + 'additional-resources/community-and-governance/governance-overview', + 'additional-resources/community-and-governance/economics', + 'additional-resources/community-and-governance/useful-links', + ], }, ], - */ - - docs: { - "Welcome to MultiversX": ["welcome/welcome-to-multiversx"], - Technology: [ - "technology/architecture-overview", - "technology/glossary", - "technology/entities", - "technology/chronology", - "technology/secure-proof-of-stake", - "technology/adaptive-state-sharding", - "technology/the-wasm-vm", - "technology/cross-shard-transactions", - ], - Developers: [ - "developers/overview", - { - type: "category", - label: "Tutorials", - items: [ - "developers/tutorials/your-first-dapp", - "developers/tutorials/your-first-microservice", - "developers/tutorials/crowdfunding-p1", - "developers/tutorials/crowdfunding-p2", - "developers/tutorials/counter", - "developers/tutorials/staking-contract", - "developers/tutorials/energy-dao", - "developers/tutorials/dex-walkthrough", - "developers/tutorials/wallet-connect-v2-migration", - ], - }, - { - type: "category", - label: "Smart Contracts", - items: [ - "developers/smart-contracts", - { - type: "category", - label: "Rust Developer reference", - items: [ - "developers/developer-reference/sc-annotations", - "developers/developer-reference/sc-modules", - "developers/developer-reference/sc-payments", - "developers/developer-reference/sc-contract-calls", - "developers/developer-reference/upgrading-smart-contracts", - "developers/developer-reference/sc-api-functions", - "developers/developer-reference/storage-mappers", - "developers/developer-reference/rust-testing-framework", - "developers/developer-reference/rust-testing-framework-functions-reference", - "developers/developer-reference/sc-debugging", - "developers/developer-reference/sc-random-numbers", - ], - }, - { - type: "category", - label: "Data", - items: [ - "developers/data/serialization-overview", - "developers/data/simple-values", - "developers/data/composite-values", - "developers/data/custom-types", - "developers/data/defaults", - "developers/data/multi-values", - "developers/data/code-metadata", - "developers/data/abi", - ], - }, - { - type: "category", - label: "Rust Developers Best Practices", - items: [ - "developers/best-practices/best-practices-basics", - "developers/best-practices/biguint-operations", - "developers/best-practices/the-dynamic-allocation-problem", - ], - }, - { - type: "category", - label: "Configuration & Tooling", - items: [ - "developers/meta/sc-meta", - "developers/meta/sc-build-reference", - "developers/meta/sc-config", - "developers/meta/sc-meta-cli", - "developers/meta/sc-allocator", - "developers/meta/rust-nightly", - ], - }, - { - type: "category", - label: "Testing", - items: [ - "developers/testing/testing-overview", - { - type: "category", - label: "Scenarios", - items: [ - "developers/testing/scenario/concept", - "developers/testing/scenario/structure-json", - "developers/testing/scenario/values-simple", - "developers/testing/scenario/values-complex", - "developers/testing/scenario/running-scenarios", - "developers/testing/scenario/generating-scenarios", - ], - }, - "developers/testing/testing-in-go", - ], - }, - ], - }, - { - type: "category", - label: "Event logs", - items: [ - "developers/event-logs/contract-call-events", - "developers/event-logs/contract-deploy-events", - "developers/event-logs/esdt-events", - "developers/event-logs/execution-events", - "developers/event-logs/system-delegation-events", - ], - }, - { - type: "category", - label: "Blockchain Operations", - items: [ - "developers/account-storage", - "developers/built-in-functions", - "developers/constants", - "developers/contract-api-limits", - "developers/creating-wallets", - { - type: "category", - label: "Gas and Fees", - items: [ - "developers/gas-and-fees/overview", - "developers/gas-and-fees/egld-transfers", - "developers/gas-and-fees/system-smart-contracts", - "developers/gas-and-fees/user-defined-smart-contracts", - ], - }, - "developers/guard-accounts", - "developers/relayed-transactions", - "developers/reproducible-contract-builds", - "developers/sc-calls-format", - "developers/setup-local-testnet", - "developers/setup-local-testnet-advanced", - { - type: "category", - label: "Signing Transactions", - items: [ - "developers/signing-transactions/signing-transactions", - "developers/signing-transactions/tools-for-signing", - "developers/signing-transactions/signing-programmatically", - ], - }, - ], - }, - { - type: "category", - label: "Guidelines", - items: ["developers/guidelines/react-development"], - }, - ], - "SDK and Tools": [ - "sdk-and-tools/overview", - { - type: "category", - label: "Rest API", - items: [ - "sdk-and-tools/rest-api/rest-api", - "sdk-and-tools/rest-api/multiversx-api", - { - type: "category", - label: "MultiversX Gateway", - items: [ - "sdk-and-tools/rest-api/gateway-overview", - "sdk-and-tools/proxy", - "sdk-and-tools/rest-api/addresses", - "sdk-and-tools/rest-api/transactions", - "sdk-and-tools/rest-api/network", - "sdk-and-tools/rest-api/nodes", - "sdk-and-tools/rest-api/blocks", - "sdk-and-tools/rest-api/virtual-machine", - "sdk-and-tools/rest-api/versions-and-changelog", - ], - }, - ], - }, - { - type: "category", - label: "Elasticsearch", - items: [ - "sdk-and-tools/elastic-search", - "sdk-and-tools/indexer", - "sdk-and-tools/es-index-wrong-mapping", - { - type: "category", - label: "Elasticsearch indices", - items: [ - "sdk-and-tools/indices/es-index-accounts", - "sdk-and-tools/indices/es-index-accountsesdt", - "sdk-and-tools/indices/es-index-accountsesdthistory", - "sdk-and-tools/indices/es-index-accountshistory", - "sdk-and-tools/indices/es-index-blocks", - "sdk-and-tools/indices/es-index-delegators", - "sdk-and-tools/indices/es-index-epochinfo", - "sdk-and-tools/indices/es-index-logs", - "sdk-and-tools/indices/es-index-miniblocks", - "sdk-and-tools/indices/es-index-operations", - "sdk-and-tools/indices/es-index-rating", - "sdk-and-tools/indices/es-index-receipts", - "sdk-and-tools/indices/es-index-rounds", - "sdk-and-tools/indices/es-index-scdeploys", - "sdk-and-tools/indices/es-index-scresults", - "sdk-and-tools/indices/es-index-tags", - "sdk-and-tools/indices/es-index-tokens", - "sdk-and-tools/indices/es-index-transactions", - "sdk-and-tools/indices/es-index-validators", - ], - }, - ], - }, - "sdk-and-tools/notifier", - "sdk-and-tools/chain-simulator", - "sdk-and-tools/google-bigquery", - "sdk-and-tools/devcontainers", - { - type: "category", - label: "SDKs", - items: [ - { - type: "category", - label: "Python SDK", - items: [ - "sdk-and-tools/sdk-py/sdk-py", - "sdk-and-tools/sdk-py/sdk-py-cookbook", - "sdk-and-tools/sdk-py/installing-mxpy", - "sdk-and-tools/sdk-py/configuring-mxpy", - "sdk-and-tools/sdk-py/mxpy-cli", - "sdk-and-tools/sdk-py/deriving-the-wallet-pem-file", - "sdk-and-tools/sdk-py/smart-contract-interactions", - "sdk-and-tools/sdk-py/sdk-py-migration-guides", - ], - }, - { - type: "category", - label: "Javascript SDK", - items: [ - "sdk-and-tools/sdk-js/sdk-js", - { - label: "Cookbook", - type: "doc", - id: "sdk-and-tools/sdk-js/sdk-js-cookbook-v13", - }, - { - type: "category", - label: "Cookbook (versioned)", - link: { - type: "doc", - id: "sdk-and-tools/sdk-js/sdk-js-cookbook-versions" - }, - items: [ - "sdk-and-tools/sdk-js/sdk-js-cookbook-v12", - "sdk-and-tools/sdk-js/sdk-js-cookbook-v13", - ] - }, - "sdk-and-tools/sdk-js/extending-sdk-js", - "sdk-and-tools/sdk-js/writing-and-testing-sdk-js-interactions", - "sdk-and-tools/sdk-js/sdk-js-migration-guides", - "sdk-and-tools/sdk-js/sdk-js-signing-providers", - ], - }, - { - type: "category", - label: "NestJS SDK", - items: [ - "sdk-and-tools/sdk-nestjs/sdk-nestjs", - "sdk-and-tools/sdk-nestjs/sdk-nestjs-auth", - "sdk-and-tools/sdk-nestjs/sdk-nestjs-cache", - "sdk-and-tools/sdk-nestjs/sdk-nestjs-monitoring", - ], - }, - "sdk-and-tools/sdk-go", - "sdk-and-tools/mxjava", - { - type: "category", - label: "dApp SDK", - items: [ - "sdk-and-tools/sdk-dapp/sdk-dapp", - { - type: "category", - label: "Internal Processes", - items: ["sdk-and-tools/sdk-dapp/internal-processes/guardians"], - }, - ], - }, - "sdk-and-tools/erdcpp", - "sdk-and-tools/erdkotlin", - "sdk-and-tools/sdk-js-wallet-cli" - ], - }, - { - type: "category", - label: "Troubleshooting", - items: [ - "sdk-and-tools/troubleshooting/troubleshooting", - "sdk-and-tools/troubleshooting/rust-setup", - "sdk-and-tools/troubleshooting/ide-setup", - "sdk-and-tools/troubleshooting/multiplatform", - ], - } - ], - Wallet: [ - "wallet/overview", - "wallet/web-wallet", - "wallet/xalias", - "wallet/wallet-extension", - "wallet/webhooks", - "wallet/ledger", - "wallet/xportal", - "wallet/create-a-fungible-token", - "wallet/keystore", - ], - Tokens: ["tokens/overview", "tokens/esdt-tokens", "tokens/nft-tokens"], - Validators: [ - "validators/overview", - "validators/staking-v4", - "validators/system-requirements", - { - type: "category", - label: "Setup", - items: [ - "validators/nodes-scripts/config-scripts", - "validators/nodes-scripts/install-update", - ], - }, - "validators/node-upgrades", - { - type: "category", - label: "Nodes Management", - items: [ - "validators/nodes-scripts/manage-node", - "validators/nodes-scripts/use-docker", - "validators/rating", - "validators/redundancy", - "validators/node-configuration", - "validators/node-operation-modes", - "validators/import-db", - "validators/node-cli", - "validators/node-databases", - "validators/useful-links", - ], - }, - { - type: "category", - label: "Staking, Unstaking, Unjailing", - items: [ - "validators/staking/staking", - "validators/staking/unjailing", - "validators/staking/staking-smart-contract", - ], - }, - { - type: "category", - label: "The Delegation Manager", - items: [ - "validators/delegation-manager", - "validators/delegation-dashboard", - "validators/staking/convert-existing-validator-into-staking-pool", - "validators/staking/merge-validator-delegation-sc", - ], - }, - { - type: "category", - label: "Keys management", - items: [ - "validators/key-management/validator-keys", - "validators/key-management/wallet-keys", - "validators/key-management/protect-keys", - "validators/key-management/multikey-nodes", - ], - }, - { - type: "category", - label: "FAQs and tools", - items: ["validators/faq", "validators/useful-links"], - }, - ], - Economics: [ - "economics/economics-overview", - "economics/staking-providers-apr", - ], - Governance: [ - "governance/overview", - "governance/governance-interaction", - ], - Integrators: [ - "integrators/overview", - { - type: "category", - label: "Integrate EGLD", - items: ["integrators/egld-integration-guide"], - }, - { - type: "category", - label: "Integrate ESDT tokens", - items: ["integrators/esdt-tokens-integration-guide"], - }, - { - type: "category", - label: "Host MultiversX infrastructure", - items: [ - "integrators/observing-squad", - "integrators/deep-history-squad", - "integrators/snapshotless-observing-squad", - "integrators/advanced-observer-settings" - ], - }, - { - type: "category", - label: "Blockchain Operations", - items: [ - "integrators/accounts-management", - "integrators/creating-transactions", - "integrators/querying-the-blockchain", - ], - }, - "integrators/walletconnect-json-rpc-methods", - ], - "Ad-Astra Bridge": [ - "bridge/architecture", - "bridge/transfer-flows", - "bridge/multiple-chains", - "bridge/whitelist-requirements", - ], - }, }; module.exports = sidebars;