mkdocs.yml

site_name: Developer Documentation
site_url: https://docs.fetch.ai/
site_description: Everything you need to know about Fetch.ai.
edit_uri: ""
site_author: developer@fetch.ai
copyright: > # Copyright notice in footer + trigger cookie consent settings
  Copyright © 2018 - 2023 Fetch.ai -
  <a href="#__consent">Change cookie settings</a>

strict: true

theme:
  name: material
  language: en
  palette: # Set light/dark theme button next to the search bar
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  logo: images/logo.png  # Set Fetch Logo top left
  favicon: images/favicon.ico  # Set Fetch favicon
  features:
    - navigation.instant # Fast page loading
    - navigation.tracking # URL automatically updated with the currently active anchor
    - navigation.top # Back-to-top button
    - navigation.footer # Add links to the previous and next page of the current page
    - navigation.tabs # First level of navigation item are in the top menu bar
    - navigation.tabs.sticky # To hold the top navigation bar in place
    - search.suggest # Completion for the searched word (can be accepted with ->).
    - search.highlight # Highlight all occurrences after following a search result link
    - search.share # Show share button for copying deep link to the current search query and result
    - toc.follow # Follow the table of content
    - content.code.copy # Shows a button next to code blocks to copy the code into clipboard
  custom_dir: overrides # Needed for announcements

nav:
  - Overview:
    - At a Glance: "index.md"
    - Learn the Concepts:
      - Decentralization: 'decentralisation.md'
      - Peer-to-Peer Applications: 'learn_the_concepts/peer_to_peer_systems.md'
      - Agent-based and Multi-agents systems: 'learn_the_concepts/agent-based_and_multi-agents_systems.md'
      - Blockchains:
          - What is a Blockchain?: 'learn_the_concepts/blockchains/what_is_a_blockchain.md'
          - Smart Contracts: 'learn_the_concepts/blockchains/smart_contracts.md'
          - Decentralized Applications: 'learn_the_concepts/blockchains/decentralized_applications.md'
          - Consensus: 'learn_the_concepts/blockchains/consensus.md'
          - Validators: 'learn_the_concepts/blockchains/validators.md'
          - Transaction Fees: 'learn_the_concepts/blockchains/transaction_fees.md'
          - Oracles: 'learn_the_concepts/blockchains/oracles.md'
    - Basics:
      - Wallet:
          - Getting Started: "basics/wallet/getting_started.md"
          - How to Use: "basics/wallet/how_to_use_wallet.md"
      - Staking:
        - What is Staking?: 'basics/staking/what_is_staking.md'
        - How to Stake: 'basics/staking/how_to_stake.md'
        - Different ways to stake FET: "basics/staking/different_ways_to_stake_fet.md"
        - Re-Delegation: 'basics/staking/redelegation.md'
      - Native and ERC-20 FET:
        - Native and ERC-20 FET: 'native_and_erc20/native_and_erc20_fet.md'
        - How to convert: 'native_and_erc20/how_to_convert_fet.md'
        - Reconciliation service: 'native_and_erc20/reconciliation.md'
    - Bug Bounty Program: "bug_bounty.md"
    - Developer Fund: "fund_form.md"
    - Glossary: 'learn_the_concepts/glossary.md'
  - Fetch wallet: '!include ./fetch-wallet/mkdocs.yml'
  - AEA Framework: '!include ./aea/mkdocs.yml'
  - μAgents: '!include ./uAgents/mkdocs.yml'
  - CosmPy: '!include ./cosmpy/mkdocs.yml'
  - Jenesis: '!include ./jenesis/mkdocs.yml'
  - Ledger: '!include ./ledger/docs/mkdocs.yml'
  - Indexer: '!include ./ledger-subquery/mkdocs.yml'
  - Create React App template: '!include ./cra-template-cosmjs-keplr/mkdocs.yml'
  - Collective Learning: '!include ./colearn/mkdocs.yml'
  - Archives:
    - Search and Discovery (SOEF):
      - Simple OEF: 'soef/simple-oef.md'
      - SOEF Connection: 'soef/simple-oef-usage.md'

extra_css:  # Required for the Fetchy design style
  - css/style.css
  - css/termynal-fast.css
  - css/admonitions.css

extra_javascript:
  - js/termynal-fast.js

markdown_extensions:
  - admonition # Required by admonitions
  - pymdownx.superfences: # Required by admonitions, annotations, tabs. Enables arbitrary nesting of code and content blocks
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight: # Required by code blocks
      anchor_linenums: true
  - pymdownx.inlinehilite # Required by code blocks
  - pymdownx.snippets # Required by code blocks
  - pymdownx.superfences # Required by admonitions, code blocks
  - pymdownx.details # Required by admonitions, code blocks
  - attr_list # Required by annotations
  - md_in_html # Required by annotations
  - pymdownx.tabbed: # Required by tabs
      alternate_style: true
  - tables # # Required by tables
  - def_list
  - toc:
      permalink: true
  - markdown_include.include:
      base_path: ./colearn/docs

plugins:
  - monorepo
  - search # Enables search
  - macros # Enables using variables, e.g. {{ repo_root }}

extra:
  repo_root: https://github.com/fetchai/colearn/tree/master/
  fund_form_api: https://fund-backend.fetch.ai
  generator: false
  analytics:
    provider: google
    property: G-GYC9HYF1LD
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            <a href="https://github.com/fetchai/docs/issues/new?labels=feedback&template=improve-docs.yml&title=[feedback]+{title}+-+{url}" target="_blank" rel="noopener">reporting what's wrong</a>.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your preferences and measure the effectiveness of our 
      documentation via the feedback widget at the bottom of every docs page.
      With your consent, you're helping us make this documentation better.
    actions:
      - accept
      - manage
      - reject
  social:
    - icon: fontawesome/brands/twitter
      link: https://bit.ly/3oDuI3f
      name: fetch.ai on Twitter
    - icon: fontawesome/brands/telegram
      link: https://t.me/fetch_ai
      name: fetch.ai on Telegram
    - icon: fontawesome/brands/discord
      link: https://bit.ly/3ra5uMI
      name: fetch.ai on Discord
    - icon: fontawesome/brands/github
      link: https://bit.ly/3AFCWxl
      name: fetch.ai on GitHubs
    - icon: fontawesome/brands/reddit
      link: https://bit.ly/30zS1Tg
      name: fetch.ai on Reddit
    - icon: fontawesome/brands/youtube
      link: https://bit.ly/3DxFazs
      name: fetch.ai on YouTube
    - icon: fontawesome/brands/linkedin
      link: https://bit.ly/3kNO70p
      name: fetch.ai on LinkedIn