mkdocs.yml

site_name: Curve Technical Docs
site_url: https://docs.curve.fi/
site_author: CurveFi

plugins:
  - search
  - autolinks
  - typeset
  - git-revision-date-localized:
      type: timeago
  - minify:
      minify_html: true
  - swagger-ui-tag:


# extension 
markdown_extensions:
  - footnotes
  - def_list
  - abbr
  - attr_list
  - md_in_html
  - admonition
  - meta
  - toc:
      permalink: true
      baselevel: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.smartsymbols
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true

theme:
  name: material
  custom_dir: overrides
  include_search_page: false
  search_index_only: true
  font:
    text: Roboto
    code: Roboto Mono
  logo: "assets/images/lama.png"
  favicon: "assets/images/lama.png"
  icon:
    repo: simple/github
    annotation: material/skull-outline
  features:
    - content.action.edit
    - content.tooltips
    - content.code.annotate
    - content.footnote.tooltips
    - navigation.indexes
    - navigation.path
    - navigation.top
    - navigation.tracking
#    - search.highlight
#    - search.share
#    - search.suggest
    - toc.follow
    - content.code.copy
    - announce.dismiss
  palette:
    # - media: "(prefers-color-scheme: dark)"
    - scheme: default
      accent: deep purple
    #  toggle:
    #    icon: material/weather-sunny
    #    name: Switch to light mode
    # - media: "(prefers-color-scheme: light)"
    # - scheme: slate
    #   accent: amber
    #   toggle:
    #     icon: material/weather-night
    #     name: Switch to dark mode


extra_css:
  - assets/stylesheets/extra.css  

extra_javascript:
  - assets/javascripts/extra.js
  - assets/javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


repo_name: CurveDocs/curve-docs
repo_url: https://github.com/CurveDocs/curve-docs



nav:
  - Documentation Overview: documentation-overview.md

  - Curve DAO Token: curve_dao/crv-token.md

  - Vote-Escrowed CRV:
    - VotingEscrow:
      - Contract Methods: curve_dao/voting-escrow/voting-escrow.md
      - Admin Controls: curve_dao/voting-escrow/admin-controls.md
    - SmartWalletChecker: curve_dao/voting-escrow/smartwalletchecker.md

  - Liquidity Gauges and Minting CRV:

    - Overview & Implementation: liquidity-gauges-and-minting-crv/overview.md
    - GaugeController: liquidity-gauges-and-minting-crv/gauge-controller/GaugeController.md
    - Minter: liquidity-gauges-and-minting-crv/minter/Minter.md 
    - Gauges:
      - Overview: liquidity-gauges-and-minting-crv/gauges/overview.md
      - LiquidityGaugeV6: liquidity-gauges-and-minting-crv/gauges/LiquidityGaugeV6.md

    - Gauges for EVM Sidechains: 
      - Overview: liquidity-gauges-and-minting-crv/xchain-gauges/overview.md
      - RootGaugeFactory: liquidity-gauges-and-minting-crv/xchain-gauges/RootGaugeFactory.md
      - ChildGaugeFactory: liquidity-gauges-and-minting-crv/xchain-gauges/ChildGaugeFactory.md
      - RootGauge: liquidity-gauges-and-minting-crv/xchain-gauges/RootGauge.md
      - ChildGauge: liquidity-gauges-and-minting-crv/xchain-gauges/ChildGauge.md
      - Bridgers: liquidity-gauges-and-minting-crv/xchain-gauges/Bridgers.md

      #- Boosting:
      #  - Updater: liquidity-gauges-and-minting-crv/xchain-gauges/Updater.md
      #  - L2 VotingEscrow Oracle: liquidity-gauges-and-minting-crv/xchain-gauges/L2VotingEscrowOracle.md

  - Governance and Voting:  
    - Overview: governance/overview.md
    - Curve-DAO Tool: governance/curve-dao.md
    - L2 Governance (x-gov):
      - Overview: governance/x-gov/overview.md
      - Broadcaster: governance/x-gov/broadcaster.md
      - Relayer: governance/x-gov/relayer.md
      - Agents: governance/x-gov/agents.md
      - Vault: governance/x-gov/vault.md


  - Fee Collection & Distribution:
      - Overview: fees/overview.md
      - FeeSplitter: fees/FeeSplitter.md
      - FeeCollector: fees/FeeCollector.md
      - CowSwapBurner: fees/CowSwapBurner.md
      - Hooker: fees/Hooker.md
      - FeeDistributor: fees/FeeDistributor.md
      - Original Architecture:
        - Overview: fees/original-architecture/overview.md
        - Burner: fees/original-architecture/burner.md
        - FeeDistributor: fees/original-architecture/distributor.md
        - Sidechains: fees/original-architecture/sidechains.md
        - Withdraw and Burn: fees/original-architecture/withdraw-and-burn.md


  - Registry:
    - Overview: registry/overview.md
    - MetaRegistry API: registry/MetaRegistryAPI.md


  - Curve API:
    - curve-api: curve-api/curve-api.md
    - curve-prices: curve-api/curve-prices.md


  - Routers:
    - CurveRouterNG: router/CurveRouterNG.md
    - CurveRegistryExchange: router/CurveRegistryExchange.md


  - crvUSD:
    - Overview: crvUSD/overview.md
    - crvUSD Token: crvUSD/crvUSD.md
    - Controller: crvUSD/controller.md
    - LLAMMA: crvUSD/amm.md
    - Monetary Policy: crvUSD/monetarypolicy.md
    - PriceAggregator: crvUSD/priceaggregator.md
    - Oracle: crvUSD/oracle.md
    - FlashLender: crvUSD/flashlender.md
    - PegKeepers:
      - Overview: crvUSD/pegkeepers/overview.md
      - PegKeeperV1: crvUSD/pegkeepers/PegKeeperV1.md
      - PegKeeperV2: crvUSD/pegkeepers/PegKeeperV2.md
      - PegKeeperRegulator: crvUSD/pegkeepers/PegKeeperRegulator.md
    - Leverage:
      - Overview: crvUSD/leverage/overview.md
      - Curve Pools: crvUSD/leverage/LeverageZap.md
      - 1inch Router: crvUSD/leverage/LeverageZap1inch.md
      - Odos Router: crvUSD/leverage/LlamaLendOdosLeverageZap.md
    - Factory:
      - Overview: crvUSD/factory/overview.md
      - Deployer API: crvUSD/factory/deployer-api.md
      - Admin Controls: crvUSD/factory/admin-controls.md


  - Savings crvUSD:
    - Overview: scrvusd/overview.md
    - RewardsHandler: scrvusd/RewardsHandler.md
    - StablecoinLens: scrvusd/StablecoinLens.md
    - Crosschain Oracles:
      - Oracle V0: scrvusd/crosschain/oracle-v0/oracle.md
      - Oracle V1/V2:
        - Overview: scrvusd/crosschain/oracle-v2/overview.md
        - Oracle: scrvusd/crosschain/oracle-v2/oracle.md
        - Verifier: scrvusd/crosschain/oracle-v2/verifier.md
        - BlockHash: scrvusd/crosschain/oracle-v2/blockhash.md

  - Curve Lending:
    - Overview: lending/overview.md
    - Vault: lending/contracts/vault.md
    - LLAMMA and Controller: lending/contracts/controller-llamma.md
    - OneWay Lending Factory: lending/contracts/oneway-factory.md
    - Leverage: lending/contracts/leverage.md
    - Monetary Policies:
      - Overview: lending/contracts/mp-overview.md
      - SemiLog Monetary Policy: lending/contracts/semilog-mp.md
      - Secondary Monetary Policy: lending/contracts/secondary-mp.md
    - Oracles Contracts:
      - Overview & Examples: lending/contracts/oracle-overview.md
      - CryptoFromPool.vy: lending/contracts/cryptofrompool.md
      - CryptoFromPoolsRate.vy: lending/contracts/cryptofrompoolsrate.md
      - CryptoFromPoolVault.vy: lending/contracts/cryptofrompoolvault.md


  - StableSwap Exchange:
    - Overview: stableswap-exchange/overview.md

    - Stableswap:    
      - Pools:
        - Overview: stableswap-exchange/stableswap/pools/overview.md
        - Plain Pools: stableswap-exchange/stableswap/pools/plain_pools.md
        - Lending Pools: stableswap-exchange/stableswap/pools/lending_pools.md
        - Metapools: stableswap-exchange/stableswap/pools/metapools.md
        - Admin Controls: stableswap-exchange/stableswap/pools/admin_pool_settings.md
      - Liquidity Pool Tokens:
        - Overview: stableswap-exchange/stableswap/lp_tokens/overview.md
        - Curve Token V1: stableswap-exchange/stableswap/lp_tokens/curve_token_v1.md
        - Curve Token V2: stableswap-exchange/stableswap/lp_tokens/curve_token_v2.md
        - Curve Token V3: stableswap-exchange/stableswap/lp_tokens/curve_token_v3.md
      - Deposit Contracts:
        - Overview: stableswap-exchange/stableswap/deposit_contracts/overview.md
        - Lending Pool Deposits: stableswap-exchange/stableswap/deposit_contracts/lending_pool_deposits.md
        - Metapool Deposits: stableswap-exchange/stableswap/deposit_contracts/metapool_deposits.md

    - Stableswap-NG:
      - Overview: stableswap-exchange/stableswap-ng/overview.md
      - Pools:
        - Overview: stableswap-exchange/stableswap-ng/pools/overview.md
        - Plain Pools: stableswap-exchange/stableswap-ng/pools/plainpool.md
        - Metapools: stableswap-exchange/stableswap-ng/pools/metapool.md
        - Oracles: stableswap-exchange/stableswap-ng/pools/oracles.md
        - Admin Controls: stableswap-exchange/stableswap-ng/pools/admin_controls.md
      - Utility Contracts: 
          - Math: stableswap-exchange/stableswap-ng/utility_contracts/math.md
          - Views: stableswap-exchange/stableswap-ng/utility_contracts/views.md
      - Custom Implementations:
        - Custom Admin Controls (EYWA): stableswap-exchange/stableswap-ng/implementations/custom1.md


  - CryptoSwap Exchange:
    - Overview: cryptoswap-exchange/overview.md

    - CryptoSwap:
      - Pools:
        - Crypto Pool: cryptoswap-exchange/cryptoswap/pools/crypto-pool.md
        - Admin Controls: cryptoswap-exchange/cryptoswap/pools/admin-controls.md
      - Liquidity Pool Tokens:
        - Overview: cryptoswap-exchange/cryptoswap/lp_tokens/overview.md
        - Curve Token V5: cryptoswap-exchange/cryptoswap/lp_tokens/lp-token-V5.md

    - TwoCrypto-NG:
      - Overview: cryptoswap-exchange/twocrypto-ng/overview.md
      - Pools:
        - Overview: cryptoswap-exchange/twocrypto-ng/pools/overview.md
        - TwoCrypto Pool: cryptoswap-exchange/twocrypto-ng/pools/twocrypto.md
        - Admin Controls: cryptoswap-exchange/twocrypto-ng/pools/admin-controls.md
      - Utility Contracts: 
        - Math: cryptoswap-exchange/twocrypto-ng/utility-contracts/math.md
        - Views: cryptoswap-exchange/twocrypto-ng/utility-contracts/views.md

    - TriCrypto-NG:
      - Overview: cryptoswap-exchange/tricrypto-ng/overview.md
      - Pools:
        - TriCrypto Pool: cryptoswap-exchange/tricrypto-ng/pools/tricrypto.md
        - Oracles: cryptoswap-exchange/tricrypto-ng/pools/oracles.md
        - Admin Controls: cryptoswap-exchange/tricrypto-ng/pools/admin-controls.md
      - Utility Contracts: 
        - Math: cryptoswap-exchange/tricrypto-ng/utility-contracts/math.md
        - Views: cryptoswap-exchange/tricrypto-ng/utility-contracts/views.md


  - Pool Factory:
    - Overview: factory/overview.md
    - StableSwap-NG:
      - Overview: factory/stableswap-ng/overview.md
      - Deployer API: factory/stableswap-ng/deployer-api.md
    - TwoCrypto-NG:
      - Overview: factory/twocrypto-ng/overview.md
      - Deployer API: factory/twocrypto-ng/deployer-api.md
    - TriCrypto-NG:
      - Overview: factory/tricrypto-ng/overview.md
      - Deployer API: factory/tricrypto-ng/deployer-api.md
    - StableSwap: 
      - Overview: factory/stableswap/overview.md
      - Deployer API: factory/stableswap/deployer-api.md
      - Implementations: factory/stableswap/implementations.md
    - CryptoSwap:
      - Overview: factory/cryptoswap/overview.md
      - Deployer API: factory/cryptoswap/deployer-api.md
      - Implementations: factory/cryptoswap/implementations.md
    

  - Integration & Guides: 
    - Overview: integration/overview.md
    - Address Provider: integration/address-provider.md
    - Meta Registry: integration/metaregistry.md
    - Rate Provider: integration/rate-provider.md

  - Bug Bounty & Audits: security/security.md

  - References:
    - Whitepapers: references/whitepaper.md
    - Useful Resources: references/useful.md
    - Contract Ownership: references/curve-practices.md
    - Notebooks: references/notebooks.md

  - Deployment Addresses:
    - Curve DAO: deployments/dao.md
    - Cross-Chain Gauges & Governance: deployments/crosschain.md
    - AMM: deployments/amm.md
    - Router & Zaps: deployments/router-zaps.md
    - crvUSD & scrvUSD: deployments/crvusd.md
    - Lending: deployments/lending.md
    - Integration: deployments/integration.md