mkdocs.yml

# Project information
site_name: Documentation
site_url: https://xinfin.org/
site_author: XDC Network
site_description: >-
  Get started with XDC Chain Docs. Explore the documentation for XDC Chain
# Repository
repo_name: XDC Network GitHub
repo_url: https://github.com/XinFinOrg/Docs
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/xdc.svg
  custom_dir: overrides
  language: en
  icon:
    repo: fontawesome/brands/github
    share: octicons/share-android-24
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: octicons/sun-24
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: octicons/moon-24
        name: Switch to dark mode
  features:
#    - announce.dismiss
    - search.suggest
    - search.highlight
    - search.share
    - navigation.instant
#    - navigation.instant.progress
    - navigation.tracking
    - navigation.integration
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.sections
#    - navigation.expand
    - navigation.prune
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.action.edit
    - content.tooltips
#    - content.action.view


# Page tree
nav:
  - Home: index.md

# NEW: Learn Section (for newcomers)
  - Learn:
    - Overview: ./learn/index.md
    - Blockchain Basics: ./learn/blockchain-basics.md
    - XDC Architecture: ./learn/xdc-architecture.md
    - XDPoS Explained: https://xinfin.org/xdpos
    - Gas & Fees: ./learn/gas-fees.md
    - Glossary: ./learn/glossary.md
    # - FAQ: ./learn/faq.md

  - XDC Chain:
    - XDC Chain Overview: ./xdcchain/index.md
    - XDPoS Consensus: ./xdcchain/xdpos.md
    - XDPoS 2.0: ./xdcchain/xdpos2.md
    - XDC Ecosystem: https://xinfin.org/ecosystem-dapps
    - Developers:
        - Quick Guide: ./xdcchain/developers/quick-guide.md
        - USDC Quickstart: ./xdcchain/developers/usdc-quickstart.md
        - Dev-Tools: https://xinfin.org/quick-tools-guide
        - RPC Endpoints:
            - RPC: ./xdcchain/developers/rpc.md/
            - Mainnet RPC: ./xdcchain/developers/mainnetrpc.md
            - Apothem Testnet RPC: ./xdcchain/developers/apothemrpc.md
            - Devnet RPC: ./xdcchain/developers/devnetrpc.md
        - Faucet: https://faucet.apothem.network/
        - Migrating from EVM to XDC: ./xdcchain/evmtoxdc.md
        - Wallet Configuration: ./xdcchain/developers/wallet-configuration.md
        - Get XDC Listed: ./xdcchain/developers/getxdclisted.md
        - XDC2.0 Private Network: ./xdcchain/developers/xdposchain_privatenet.md
    
    - Node Operators:
        - Node Architecture: ./xdcchain/developers/node_operators/node_architecture.md
        - Rewards mechanism(WIP): ./xdcchain/rewards.md
        - How to Run a Masternode/Standby node: 
              - Masternode(Full Node)/Standby Node Setup: ./xdcchain/developers/node_operators/masternode.md
              - How to Stake XDC: ./xdcchain/developers/node_operators/masternode/#how-to-stake-xdc-on-a-masternodestandby-node
              - Using Bootstrap Script: ./xdcchain/developers/node_operators/masternode/#setup-xdc-masternode-using-bootstrap-script
              - Using Docker: ./xdcchain/developers/node_operators/masternode/#setup-xdc-masternodestandby-node-using-docker
              - Using Snapshot: ./xdcchain/developers/node_operators/masternode/#setup-xdc-masternodefull-nodestandby-node-using-snapshots
              - Downloading Mainnet Snapshot: ./xdcchain/developers/node_operators/masternode/#mainnet-snapshot 
              - Downloading Apothem Snapshot: ./xdcchain/developers/node_operators/masternode/#apothem-snapshot   
              # - How to Secure Mastecrnode(WIP): ./xdcchain/developers/node_operators/node_architecture
              # - How to Monitor Uptime(WIP): ./xdcchain/developers/node_operators/node_architecture 
              # - How to migrate an XDC Node(WIP): ./xdcchain/developers/node_operators/node_architecture   
              # - Archive Node(WIP): ./xdcchain/developers/node_operators/node_architecture
              # - Boot Node(WIP): ./xdcchain/developers/node_operators/node_architecture
        - Docker Image (WIP): ./xdcchain/developers/node_operators/dockerimg.md
        - Slashing: ./xdcchain/developers/node_operators/slashing.md  

    - Governance:
        - Overview of XDCDAO: ./xdcchain/governance/overview.md
        - User Guide: https://www.xdc.dev/0xbeny/xdcdao-understanding-the-proposal-window-39f8

    - FAQ: 
        - FAQs: ./xdcchain/faq.md  

  - XDC Subnet:
    - Overview: 
      - Design and Architecture: ./subnet/overview.md
      - Components:
        - Subnet Chain: ./subnet/components/subnet_chain.md
        - Checkpoint Smart Contract: ./subnet/components/checkpoint_contract.md
        - Relayer: ./subnet/components/relayer.md
        - API Library: ./subnet/components/api_library.md
        - XDCZero: ./subnet/components/xdc_zero.md
        - Subswap: ./subnet/components/subswap.md

    - Deployment and Usage:
      - Deployment Guide: 
        - Launch a Subnet: ./subnet/install_guide/launch_subnet.md
        - Multi-Machines Deployment: ./subnet/install_guide/multi_machines_deployment.md
        - Exposing Subnet Frontend: ./subnet/install_guide/exposing_services_frontend.md
        - Configs Explanation: ./subnet/install_guide/config_explanation.md
        - Common Issues and Troubleshooting: ./subnet/install_guide/common_issues.md
        - FAQ: ./subnet/install_guide/faq.md
        - Subnet Deployment Generator Changelog: ./subnet/install_guide/changelog.md
        
      - Using the Subnet:
        - UI Usage Guide: ./subnet/using_subnet/using_subnet.md
        - Faucet: ./subnet/using_subnet/faucet.md
        - Block Explorer: ./subnet/using_subnet/explorer.md
      - Upgrading the Subnet: ./subnet/upgrading_subnet.md

    - Resources:
      - GitHub Repositories: ./subnet/resources/repos.md
      - Changelog: ./subnet/resources/changelog.md
      - Contact: ./subnet/contact.md

  # NEW: Enterprise Section
  - Enterprise:
    - Overview: ./enterprise/index.md
    - Trade Finance: ./enterprise/trade-finance.md
    - RWA Tokenization: ./enterprise/rwa-tokenization.md
    - ISO 20022 Integration: ./enterprise/iso-20022.md
    - Private Subnets: ./enterprise/private-subnets.md

  # NEW: API Reference Section
  - API Reference:
    - Overview: ./api/index.md
    - JSON-RPC: ./api/json-rpc.md
    - WebSocket: ./api/#websocket-endpoints
    - Error Codes: ./api/#error-handling

  - Smart Contracts:
    - Overview: ./smartcontract/index.md
    - Deployment & Verification: ./smartcontract/deployment-verification.md
    - Flattening Contracts: ./smartcontract/flattening-smart-contracts.md
    - Token Standards:
        - Overview: ./smartcontract/tokens.md
        - XRC20: ./smartcontract/tokens.md#xrc20
        - XRC721: ./smartcontract/tokens.md#xrc721
        - XRC404: ./smartcontract/tokens.md#xrc404
    - XDC Stats: ./smartcontract/xdcstats.md
    - Data & Analytics: ./smartcontract/data-analytics.md

  - Announcements:
    - Announcements: ./announce/index.md
    - Upcoming:
      - Solidity 0.8.28 support on XDC Apothem: ./announce/#
    - Passed:
      - XDC Network to Introduce EIP-1559 Support on Apothem: https://www.xdc.dev/xinfin_xdc_network/xdc-network-to-introduce-eip-1559-support-on-apothem-testnet-cl4
      - XDC 2.0 Mainnet Release: https://www.xdc.dev/anilchinchawale/xdpos-20-mainnet-release-key-features-and-enhancements-eeo
      - Solidity 0.8.23 Integration on XDC Mainnet: https://www.xdc.dev/anilchinchawale/stay-ahead-xdc-network-prepares-for-evm-0823-integration-on-xdc-mainnet-upgrade-details-inside-5nj 
      
  - Smart Contract Developments:
    - Smart Contract Overview: 
      - Smart Contract overview: ./smartcontract/index.md
      - Deployment & Verification: 
        - Overview: ./smartcontract/deployment-verification.md
        - Remix: ./smartcontract/deployment-verification/#using-remix
        - Hardhat: ./smartcontract/deployment-verification/#using-hardhat 
        # - Foundry: ./smartcontract/deployment-verification/#using-foudry
        - Brownie: ./smartcontract/deployment-verification/#using-brownie
      - Flattening Smart Contracts:
                  - Overview: ./smartcontract/flattening-smart-contracts.md
                  - With Remix: ./smartcontract/flattening-smart-contracts/#flattening-smart-contracts-with-remix
                  - With Truffle: ./smartcontract/flattening-smart-contracts/#flattening-smart-contracts-with-truffle
                  - With Hardhat: ./smartcontract/flattening-smart-contracts/#flattening-smart-contracts-with-hardhat

    - Token Standards: 
        - Overview: ./smartcontract/tokens.md
        - XRC20: ./smartcontract/tokens/#xrc20
        - XRC721: ./smartcontract/tokens/#xrc721
        - XRC404: ./smartcontract/tokens/#xrc404
        - XDC Stats: 
            - XDC Stats Overview: ./smartcontract/xdcstats.md 
            - Data and analytics:  
                    - Overview: ./smartcontract/data-analytics.md
                    - XDCScan Mainnet: ./smartcontract/data-analytics/#xdcscan-mainnet
                    - XDCScan Testnet (Apothem): ./smartcontract/data-analytics/#xdcscan-testnet-apothem
                    - XDCScan Devnet: ./smartcontract/data-analytics/#xdcscan-devnet

  - White Paper: whitepaper.md
    #  - White paper: whitepaper.md       

    #  - Games:
    #    - Telegram Mini Game on XDC Chain: ./smartcontract/game/minigame.md
    #  - Wallet:
    #    - In-app Wallet and Account Abstraction: ./#
  
markdown_extensions:
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 4
  - codehilite
  - admonition
  - footnotes
  - def_list
  - attr_list
  - abbr
  - meta
  - smarty
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.mark
  - pymdownx.extra

plugins:
  - search
  - mkdocs-video
  - redirects:
      redirect_maps:
        'docs.md': 'xdcchain/index.md'
        'docs/validator/fullnode.md': 'xdcchain/developers/node_operators/full_node.md'
        'docs/rpc.md': 'xdcchain/developers/rpc.md'
      

extra_css:
  - https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300..700&display=swap
  - assets/style/index.css
  - assets/style/components/banner.css
  - assets/style/components/nav.css
  - assets/style/components/sidebar.css
  - assets/style/components/content.css
  - assets/style/components/footer-nav.css
  - assets/style/components/footer.css
  - https://unpkg.com/katex@0.16.10/dist/katex.min.css

extra_javascript:
  - assets/js/mathjax.js
  - assets/js/custom.js
  - https://unpkg.com/mathjax@3.2.2/es5/tex-mml-chtml.js
  - https://unpkg.com/katex@0.16.10/dist/katex.min.js
  - https://unpkg.com/katex@0.16.10/dist/contrib/auto-render.min.js

extra:
  generator: false
  homepage: ./#
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.