mkdocs.yml

site_name: Agglayer Documentation
site_author: Polygon Labs
copyright: Copyright © PT Services DMCC 2025
repo_name: Agglayer Documentation
repo_url: https://github.com/agglayer/agglayer-docs
edit_uri: edit/main/docs/
site_url: https://agglayer.dev/

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: white
      accent: "#FF8E08"  
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: "#FF8E08" 
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  language: en
  custom_dir: overrides
  favicon: img/favicon.ico
  logo: img/agglayer/agglayer-logo-mark-black-rgb.svg
  icon:
    logo: logo
    repo: repo
  features:
    - 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.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.action.edit
    - navigation.indexes

nav:
  - Agglayer: 
      - agglayer/index.md
      - Get Started:
        - agglayer/get-started/index.md
        - Quickstart: agglayer/get-started/quickstart.md
        - Supported Networks: https://build.agglayer.dev/chains
        - Agglayer Developer Portal: https://build.agglayer.dev
      - Core Concepts:
        - agglayer/core-concepts/index.md
        - What is Agglayer?: agglayer/core-concepts/what-is-agglayer.md
        - Architecture: agglayer/core-concepts/architecture.md
        - Unified Bridge: 
          - agglayer/core-concepts/unified-bridge/index.md
          - Core Concepts:
            - Architecture: agglayer/core-concepts/unified-bridge/architecture.md
            - Data Structures: agglayer/core-concepts/unified-bridge/data-structures.md
            - Bridge Components: agglayer/core-concepts/unified-bridge/bridge-components.md
          - Bridge Operations:
            - Asset Bridging: agglayer/core-concepts/unified-bridge/asset-bridging.md
            - Message Bridging: agglayer/core-concepts/unified-bridge/message-bridging.md
        - Pessimistic Proof: 
          - agglayer/core-concepts/pessimistic-proof/index.md
          - Core Concepts:
            - Architecture: agglayer/core-concepts/pessimistic-proof/architecture.md
            - Data Structures: agglayer/core-concepts/pessimistic-proof/data-structures.md
            - Proof Generation: agglayer/core-concepts/pessimistic-proof/proof-generation.md
          - Reference:
            - Benchmarks: agglayer/core-concepts/pessimistic-proof/benchmarks.md
        - State Transition Proof: 
          - agglayer/core-concepts/state-transition-proof/index.md
          - Architecture: agglayer/core-concepts/state-transition-proof/architecture.md
          - Aggchain Proof: agglayer/core-concepts/state-transition-proof/aggchain-proof.md
        - AggKit:
          - agglayer/core-concepts/aggkit/index.md
          - Architecture: agglayer/core-concepts/aggkit/architecture.md
          - Components:
            - agglayer/core-concepts/aggkit/components/index.md
            - AggSender: agglayer/core-concepts/aggkit/components/aggsender.md
            - AggOracle: agglayer/core-concepts/aggkit/components/aggoracle.md
            - BridgeSync: agglayer/core-concepts/aggkit/components/bridge-sync.md
            - L1InfoTreeSync: agglayer/core-concepts/aggkit/components/l1infotree-sync.md
            - L2GERSync: agglayer/core-concepts/aggkit/components/l2ger-sync.md
            - AggchainProofGen: agglayer/core-concepts/aggkit/components/aggchain-proof-gen.md
      - Developer Tools:
        - agglayer/developer-tools/index.md
        - Agglayer SDK:
          - agglayer/developer-tools/agglayer-sdk/index.md
          - Getting Started:
            - Installation: agglayer/developer-tools/agglayer-sdk/installation.md
            - Quickstart: agglayer/developer-tools/agglayer-sdk/quickstart.md
          - Multi-Bridge Routes:
            - agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/index.md
            - Operations:
              - Route Discovery: agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/operations/route-discovery.md
              - Chain Metadata: agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/operations/chain-metadata.md
              - Transaction Building: agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/operations/transaction-building.md
              - Transaction History: agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/operations/transaction-history.md
              - Understanding Gas Fees: agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/operations/gas-fees.md
            - Step-by-Step Guide:
              - Multi-Bridge Routing (Mainnet): agglayer/developer-tools/agglayer-sdk/multi-bridge-routes/step-by-step-guide/multi-bridge-routing-mainnet.md
          - Agglayer Native Bridge:
            - agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/index.md
            - Operations:
              - ERC20 Operations: agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/operations/erc20-operations.md
              - Bridge Operations: agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/operations/bridge-operations.md
              - Chain Management: agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/operations/chain-management.md
            - Step-by-Step Guide:
              - Native Bridge (Locally): agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/step-by-step-guide/native-bridge-locally.md
              - Native Bridge (Testnet): agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/step-by-step-guide/native-bridge-testnet.md
              - Native Bridge (Mainnet): agglayer/developer-tools/agglayer-sdk/agglayer-native-bridge/step-by-step-guide/native-bridge-mainnet.md
          - Reference:
            - API Reference: agglayer/developer-tools/agglayer-sdk/api-reference.md
        - AggSandbox:
          - agglayer/developer-tools/aggsandbox/index.md
          - Getting Started:
            - Quickstart: agglayer/developer-tools/aggsandbox/quickstart.md
            - Installation: agglayer/developer-tools/aggsandbox/installation.md
          - Core Concepts:
            - Architecture: agglayer/developer-tools/aggsandbox/architecture.md
            - Bridge Basics: agglayer/developer-tools/aggsandbox/bridge-basics.md
          - Bridge Operations:
            - Asset Bridging: agglayer/developer-tools/aggsandbox/asset-bridging.md
            - Message Bridging: agglayer/developer-tools/aggsandbox/message-bridging.md
          - Reference:
            - CLI Commands: agglayer/developer-tools/aggsandbox/cli-commands.md
        - Lxly.js:
          - agglayer/developer-tools/lxlyjs/index.md
          - Getting Started:
            - Installation: agglayer/developer-tools/lxlyjs/installation.md
            - Client Initialization: agglayer/developer-tools/lxlyjs/client-initialization.md
          - Bridge Operations:
            - Bridge Asset: agglayer/developer-tools/lxlyjs/bridge-asset.md
            - Bridge Message: agglayer/developer-tools/lxlyjs/bridge-message.md
          - Reference:
            - API Reference: agglayer/developer-tools/lxlyjs/api-reference.md
        - Bridge Service API:
          - agglayer/developer-tools/bridge-service-api/index.md
          - API Reference: agglayer/developer-tools/bridge-service-api/api-reference.md
  - CDK:
      - CDK: cdk/index.md
      - Get Started:
        - What is CDK?: cdk/get-started/overview.md
        - Why choose CDK?: cdk/get-started/benefits.md
      - cdk-opgeth:
          - Deploy a local testnet: cdk/cdk-opgeth/local-guide.md
          - Deploy a devnet: cdk/cdk-opgeth/devnet-deployment-guide.md
          - Deploy balance scanner: cdk/cdk-opgeth/balance-scanner.md
          - Architecture: cdk/cdk-opgeth/architecture.md
      - cdk-erigon:
          - Deploy a local testnet: cdk/cdk-erigon/local-deployment.md
          - Create a native token: cdk/cdk-erigon/use-native-token.md
          - Deploy balance scanner: cdk/cdk-erigon/balance-scanner.md
          - Architecture: cdk/cdk-erigon/architecture.md
          - Migration Guides:
              - General Guide: cdk/cdk-erigon/migrate/fork.md
              - Fork ID 9 to 12: cdk/cdk-erigon/migrate/forkid-9-12.md
              - Fork ID 7 to 9: cdk/cdk-erigon/migrate/forkid-7-to-9.md
      - Additional Resources:
          - Glossary: cdk/additional-resources/glossary.md
          - FAQs: cdk/additional-resources/faqs.md
  - Vault Bridge:
    - Get Started:
      - Overview: vault-bridge/get-started/overview.md
      - Quickstart: vault-bridge/get-started/quickstart.md
    - Core Concepts:
      - Architecture: vault-bridge/core-concepts/architecture.md
      - vbTokens: vault-bridge/core-concepts/tokens.md
      - Native Converter: vault-bridge/core-concepts/native-converter.md
    - Vault Bridge Routes:
      - Agglayer Route: vault-bridge/routes/agglayer.md
      - Hyperlane Route: vault-bridge/routes/hyperlane.md
    - Reference:
      - Technical Reference: https://agglayer.github.io/vault-bridge/
      - ABI Reference: vault-bridge/reference/abi-reference.md
      - Assets & Vaults: vault-bridge/reference/assets-and-vaults.md
      - Security: vault-bridge/reference/risk-security.md

extra:
  generator: false
  analytics:
    provider: google
    property: G-PM6L5JWEZP    
  social:
    - icon: fontawesome/solid/circle-question
      link: https://support.polygon.technology/support/solutions
    - icon: fontawesome/solid/globe
      link: https://agglayer.dev/
    - icon: fontawesome/brands/github
      link: https://github.com/agglayer/agglayer-docs
  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.

extra_css:
  - _site_essentials/stylesheets/extra.css
  - https://fonts.googleapis.com/icon?family=Material+Icons
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

markdown_extensions:
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 4
  - codehilite
  - markdown_include.include:
      base_path: docs
  - admonition
  - footnotes
  - def_list
  - attr_list
  #- md_in_html
  - abbr
  - pymdownx.tabbed
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.caret
  - meta
  - smarty
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format

exclude_docs: |
  shared/

plugins:
  - multirepo:
      cleanup: true
      keep_docs_dir: false
  - search
  - open-in-new-tab
  - redirects:
      redirect_maps:
        # AggSandbox moved location - all pages
        'agglayer/aggsandbox/index.md': 'agglayer/developer-tools/aggsandbox/index.md'
        'agglayer/aggsandbox/introduction.md': 'agglayer/developer-tools/aggsandbox/index.md'
        'agglayer/aggsandbox/quickstart.md': 'agglayer/developer-tools/aggsandbox/quickstart.md'
        'agglayer/aggsandbox/installation.md': 'agglayer/developer-tools/aggsandbox/installation.md'
        'agglayer/aggsandbox/architecture.md': 'agglayer/developer-tools/aggsandbox/architecture.md'
        'agglayer/aggsandbox/bridge-basics.md': 'agglayer/developer-tools/aggsandbox/bridge-basics.md'
        'agglayer/aggsandbox/asset-bridging.md': 'agglayer/developer-tools/aggsandbox/asset-bridging.md'
        'agglayer/aggsandbox/message-bridging.md': 'agglayer/developer-tools/aggsandbox/message-bridging.md'

        'agglayer/aggsandbox/cli-commands.md': 'agglayer/developer-tools/aggsandbox/cli-commands.md'

        # Deprecated Bridge-and-Call pages redirected to closest alternatives
        'agglayer/aggsandbox/bridge-and-call.md': 'agglayer/developer-tools/aggsandbox/message-bridging.md'
        'agglayer/core-concepts/unified-bridge/bridge-and-call.md': 'agglayer/core-concepts/unified-bridge/index.md'
        'agglayer/developer-tools/lxly.js.md': 'agglayer/developer-tools/aggsandbox/message-bridging.md'
        
        # Introduction pages renamed to index.md for SEO optimization
        'agglayer/core-concepts/unified-bridge/introduction.md': 'agglayer/core-concepts/unified-bridge/index.md'
        'agglayer/core-concepts/pessimistic-proof/introduction.md': 'agglayer/core-concepts/pessimistic-proof/index.md'
        'agglayer/core-concepts/state-transition-proof/introduction.md': 'agglayer/core-concepts/state-transition-proof/index.md'
        
        # State Transition Proof files that were consolidated into aggchain-proof.md
        'agglayer/core-concepts/state-transition-proof/validity-proof.md': 'agglayer/core-concepts/state-transition-proof/aggchain-proof.md'
        'agglayer/core-concepts/state-transition-proof/ecdsa-verification.md': 'agglayer/core-concepts/state-transition-proof/aggchain-proof.md'
        
        # Pessimistic Proof files that were deleted and consolidated into benchmarks.md
        'agglayer/core-concepts/pessimistic-proof/zkvm-integration.md': 'agglayer/core-concepts/pessimistic-proof/benchmarks.md'
        'agglayer/core-concepts/pessimistic-proof/performance-benchmarks.md': 'agglayer/core-concepts/pessimistic-proof/benchmarks.md'
        
        # Lxly.js files that were renamed during restructuring
        'agglayer/developer-tools/lxlyjs/erc20-operations.md': 'agglayer/developer-tools/lxlyjs/bridge-asset.md'
        'agglayer/developer-tools/lxlyjs/custom-contracts.md': 'agglayer/developer-tools/lxlyjs/bridge-message.md'
        
        # Overview page was deleted (content moved to index.md)
        'agglayer/overview.md': 'index.md'
        
        # Developer guide was removed from unified bridge
        'agglayer/core-concepts/unified-bridge/developer-guide.md': 'agglayer/developer-tools/lxlyjs/index.md'
        
        # Introduction pages renamed to index.md for SEO optimization (developer tools)
        'agglayer/developer-tools/aggsandbox/introduction.md': 'agglayer/developer-tools/aggsandbox/index.md'
        'agglayer/developer-tools/lxlyjs/introduction.md': 'agglayer/developer-tools/lxlyjs/index.md'
        'docs/develop/network-details/network.md': 'cdk/index.md'
        'cdk/getting-started/index.md': 'cdk/getting-started/local-deployment.md'      
        'zkEVM/how-to/index.md': 'zkEVM/get-started/index.md'
        'cdk/concepts/index.md': 'cdk/concepts/layer2s.md'
        'tools/matic-js/installation.md': 'tools/matic-js/get-started.md'
        'pos/how-to/access-node.md': 'tools/dApp-development/tutorials/access-node.md'
        'pos/how-to/full-node/full-node-system-requirements.md': 'pos/how-to/prerequisites.md'
        'pos/how-to/validator/prerequisites.md': 'pos/how-to/prerequisites.md'
        'pos/how-to/validator/validator-system-requirements.md': 'pos/how-to/prerequisites.md'
        'pos/how-to/choose-node-type.md': 'pos/how-to/prerequisites.md'
        'pos/how-to/operate-validator-node/validator-best-practices.md': 'pos/how-to/validator/validator-best-practices.md'
        'pos/how-to/operate-validator-node/validator-commission-operations.md': 'pos/how-to/operate-validator-node/next-steps.md'
        'pos/how-to/operate-validator-node/validator-staking-operations.md': 'pos/how-to/operate-validator-node/next-steps.md'
        'pos/how-to/operating/validator-node/index.md': 'pos/how-to/operate-validator-node/next-steps.md'
        'cdk/version-matrix/index.md': 'index.md'
        'agglayer/core-concepts/Agglayer v0.3.0-Core-Features.md': 'agglayer/core-concepts/index.md'
        'agglayer/core-concepts/v0.3.md': 'agglayer/core-concepts/index.md'
        'agglayer/core-concepts/migration_guide.md': 'agglayer/core-concepts/index.md'
        'agglayer/core-concepts/ECDSA-vs-FEP.md': 'agglayer/core-concepts/index.md'
        'agglayer/core-concepts/v0.2_vs_v0.3.md': 'agglayer/core-concepts/index.md'

validation:
  absolute_links: warn
  anchors: warn

extra_javascript:
  - _site_essentials/js/mathjax.js
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?version=4.8.0
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js  
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js