sidebars.js

/**
 * 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.
 */

// @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

  sidebar: [
    // Ronin Network basics
    {
      type: 'category',
      label: 'Basics',
      link: {
        type: 'generated-index',
        description: 'Everything you need to know about Ronin.',
        slug: '/basics',
      },
      items: [
        // Introduction to Ronin
        {
          type: 'doc',
          label: 'Introduction to Ronin',
          id: 'basics/introduction',
        },
        // Acquire RON
        'basics/acquire-ron',
        // Key concepts
        'basics/key-concepts',
        // Consensus
        'basics/consensus',
        // Rewards
        'basics/rewards',
        // Tokenomics
        'basics/tokenomics',
        // Nodes
        'basics/nodes',
        // Security audits
        'basics/audits',
        // Roles
        'basics/roles',
        // Community
        'basics/community',
        // Contribute to the documentation
        {
          type: 'category',
          label: 'Contribute to the documentation',
          link: {
            type: 'generated-index',
            description: 'Contribute to the Ronin documentation.',
            slug: '/basics/contribute',
          },
          items: [
            // Contribution guide
            'CONTRIBUTING',
            // Content style guide
            'basics/contribute/style-guide',
            // Content templates
            'basics/contribute/templates',
          ],
        },
      ],
    },
    // dApps
    {
      type: 'category',
      label: 'dApps',
      link: {
        type: 'generated-index',
        description: 'User guides for selected dApps in the Ronin ecosystem.',
        slug: '/apps',
      },
      items: [
        // Token Revoke
        'apps/revoke',
        // RNS
        {
          type: 'category',
          label: 'Ronin Name Service',
          link: {
            type: 'doc',
            id: 'apps/rns/overview', 
          },
          items: [
            {
              type: 'category',
              label: 'Register an RNS name',
              link: {
                type: 'generated-index',
                description: 'Guides to register different categories of RNS names.',
                slug: 'apps/rns/register',
              },
              items: [
                // Register a regular RNS name
                'apps/rns/guides/register/regular',
                // Buy an RNS name at auction
                'apps/rns/guides/register/auctioned',
                // Register a protected RNS name
                'apps/rns/guides/register/protected',
              ],
            },
            // Manage RNS names
            'apps/rns/guides/manage',
            // Trade RNS names
            'apps/rns/guides/trade',
            // RNS FAQ
            'apps/rns/reference/faq',
          ],
        },
        // Ronin Bridge
        {
          type: 'category',
          label: 'Ronin Bridge',
          link: {
            type: 'doc',
            id: 'apps/ronin-bridge/overview', 
          },
          items: [
            // Deposit ERC20 tokens
            'apps/ronin-bridge/guides/deposit-token',
            // Withdraw ERC20 tokens
            'apps/ronin-bridge/guides/withdraw-token',
            // Deposit NFTs
            'apps/ronin-bridge/guides/deposit-nft',
            // Withdraw NFTs
            'apps/ronin-bridge/guides/withdraw-nft',
            // Token withdrawal limits
            'apps/ronin-bridge/reference/withdrawal-limits',
          ]
        },
        // Katana
        {
          type: 'category',
          label: 'Katana',
          link: {
            type: 'doc',
            id: 'apps/katana/overview', 
          },
          items: [
            // Swap tokens
            'apps/katana/guides/swap-tokens',
            // Liquidity pools
            {
              type: 'category',
              label: 'Liquidity pools',
              link: {
                type: 'generated-index',
                description: 'Guides for creating and managing liquidity pools.',
                slug: 'apps/katana/pools'
              },
              items: [
                // Create a liquidity pool
                'apps/katana/guides/create-pool',
                // Add liquidity to a pool
                'apps/katana/guides/add-liquidity',
              ],
            },
            // Farms
            {
              type: 'category',
              label: 'Farms',
              link: {
                type: 'generated-index',
                description: 'Guides for creating farms and staking LP tokens.',
                slug: 'apps/katana/farms',
              },
              items: [
                // Create a farm
                'apps/katana/guides/create-farm',
                // Stake LP tokens
                'apps/katana/guides/stake-tokens',
              ],
            },
          ],
        },
        // Ronin Explorer
        'apps/ronin-explorer',
        // RON Staking
        'apps/ron-staking',
        // Ronin Safe
        'apps/multisig',
      ],
    },
    // Delegators
    {
      type: 'category',
      label: 'Delegators',
      link: {
        type: 'doc',
        id: 'delegators/index',        
      },
      items: [
        // Stake RON
        'delegators/onboarding/become-delegator',
        // Manage your stake
        'delegators/manage/stake',
        // Claim or restake your rewards
        'delegators/manage/claim-rewards',
        // Track your validators
        'delegators/manage/validators',
        // FAQ
        'delegators/delegator-faq',
      ],
    },
    // Validators
    {
      type: 'category',
      label: 'Validators',
      link: {
        type: 'doc',
        id: 'validators/index',        
      },
      items: [
        {
          type: 'category',
          label: 'Setup',
          link: {
            type: 'doc',
            id: 'validators/setup/overview',   
          },
          items: [
            {
              type: 'category',
              label: 'Mainnet',
              link: {
                type: 'generated-index',
                slug: '/validators/setup/mainnet',
                description: 'Node installation guides for the Ronin mainnet.'
              },
              items: [
                // Run a validator and bridge together
                'validators/setup/mainnet/run-combined',
                // Run a validator
                'validators/setup/mainnet/run-validator',
                // Run a full node
                'validators/setup/mainnet/run-non-validator',
                // Run an archive node
                'validators/setup/mainnet/run-archive',
              ],
            },
            {
              type: 'category',
              label: 'Saigon testnet',
              link: {
                type: 'generated-index',
                title: 'Saigon testnet',
                description: 'Node installation guides for the Saigon testnet.',
                slug: '/validators/setup/testnet',
              },
              items: [
                // Run a validator and bridge together
                'validators/setup/testnet/run-combined',
                // Run a non-validator-node
                'validators/setup/testnet/run-non-validator',
                // Run a full archive node
                'validators/setup/testnet/run-archive',
              ],
            },
            // Generate keys
            'validators/setup/generate-keys',
            // Install Ronin CLI
            'validators/setup/cli',
            // Latest version
            'validators/setup/upgrade-validator',
            // Latest version
            'validators/setup/random-beacon',
            // Clean data
            'validators/setup/clean-data',
            // Network parameters
            {
              type: 'category',
              label: 'Network parameters',
              link: {
                type: 'generated-index',
                title: 'Network parameters',
                slug: '/validators/setup/parameters',
              },
              items: [
                // Ronin mainnet
                'validators/setup/parameters/mainnet',
                // Saigon testnet
                'validators/setup/parameters/testnet',
              ],
            },
            // Security hardening
            'validators/setup/security',
          ],
        },
        // Become a validator
        'validators/onboarding/become-validator',
        // Manage your account
        {
          type: 'category',
          label: 'Manage validator account',
          link: {
            type: 'generated-index',
            title: 'Manage your validator account', 
            description: 'Guides for increasing or withdrawing your stake, claiming rewards, and managing your validator account.',
            slug: '/validators/manage',
          },
          items: [
            // View activity
            'validators/manage/view-activity',
            // View analytics
            'validators/manage/view-analytics',
            // View profile details
            'validators/manage/view-profile',
            // Claim rewards
            'validators/manage/claim-rewards',
            // Increase or move stake
            'validators/manage/stake',
            // Add or change finality vote key
            'validators/manage/finality',
            // Add or change VRF key
            'validators/manage/vrf-key',
            // Change commission rate
            'validators/manage/commission',
            // Change admin address
            'validators/manage/addresses',
            // Schedule maintenance
            'validators/manage/maintenance',
            // Early exit maintenance
            'validators/manage/maintenance-exit',
            // Renounce validator role
            'validators/manage/renounce',
            // Request emergency exit
            'validators/manage/emergency-exit',
          ],
        },
        // Slashing
        'validators/slashing',
        // Governance
        {
          type: 'category',
          label: 'Governance',
          link: {
            type: 'doc',
            id: 'validators/governance/overview',        
          },
          items: [
            // Create and vote on proposals
            'validators/governance/proposals',
          ],
        },
        // FAQ
        'validators/validator-faq',
      ],
    },
    {
      type: 'category',
      label: 'Bridge operators',
      link: {
        type: 'doc',
        id: 'bridge-operators/index',   
      },
      items: [
        {
          type: 'category',
          label: 'Setup',
          link: {
            type: 'doc',
            id: 'bridge-operators/setup/overview',   
          },
          items: [
            'bridge-operators/setup/run-bridge',
            'bridge-operators/setup/upgrade-bridge',
          ],
        },
        // Slashing
        'bridge-operators/slashing',
        // Governance
        {
          type: 'category',
          label: 'Governance',
          link: {
            type: 'doc',
            id: 'bridge-operators/governance/overview',        
          },
          items: [
            // Create and vote on proposals
            'bridge-operators/governance/proposals',
          ],
        },
      ],
    },
  ],
}

module.exports = sidebars