mkdocs.yml

site_name: Docs Portal
site_description: Documentation for the Unicity Protocol, AgentSphere, and AgentStack.
site_url: https://unicitynetwork.github.io/unicity-docs/
repo_url: https://github.com/unicitynetwork/unicity-docs
repo_name: unicitynetwork/unicity-docs
copyright: Unicity Labs

theme:
  name: material
  logo: assets/logo.svg
  font:
    text: Geist
    code: Geist Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji

# Keep the build resilient: report problems, do not fail the build on
# cross-repo relative links that point at source files we did not import.
validation:
  nav:
    omitted_files: ignore
    not_found: warn
  links:
    not_found: warn
    anchors: warn

plugins:
  - search
  - multirepo:
      cleanup: true
      keep_docs_dir: true
      nav_repos:
        - name: stsdk
          import_url: https://github.com/unicitynetwork/state-transition-sdk-js?branch=main
          imports:
            - /README.md
            - /unicity-token-protocol-spec.md
        - name: sphere
          import_url: https://github.com/unicity-sphere/sphere-sdk?branch=main
          imports:
            - /README.md
            - /ARCHITECTURE.md
            - docs/QUICKSTART-NODEJS.md
            - docs/QUICKSTART-BROWSER.md
            - docs/QUICKSTART-CLI.md
            - docs/INTEGRATION.md
            - docs/L1-ALPHA.md
            - docs/UNICITY-ID.md
            - docs/API.md
            - docs/PROVIDERS-AND-CONFIG.md
            - docs/MULTI-ADDRESS.md
            - docs/PAYMENT-REQUESTS.md
            - docs/MARKET.md
            - docs/SWAP-PROTOCOL-V2.md
            - docs/CONNECT.md
            - docs/DIRECT-MESSAGES.md
            - docs/GROUP-CHAT.md
            - docs/IDENTITY-CRYPTO.md
            - docs/IPFS-STORAGE.md
            - docs/WALLET-IMPORT-EXPORT.md
        - name: astrid
          import_url: https://github.com/unicity-astrid/astrid?branch=main
          imports:
            - /README.md
            - docs/config.md
            - docs/sdk-ergonomics.md
            - docs/gateway-client.md
            - docs/gateway-deployment.md
            - docs/metrics.md

nav:
  - Home: index.md
  - Unicity Protocol:
      - Overview: protocol/index.md
      - Research Papers: protocol/research-papers.md
      - State Transition SDK (JS):
          - Overview: stsdk/README.md
          - Token Protocol Spec: stsdk/unicity-token-protocol-spec.md
  - AgentSphere:
      - Sphere SDK:
          - Overview: sphere/README.md
          - Architecture: sphere/ARCHITECTURE.md
          - Quickstart (Node.js): sphere/docs/QUICKSTART-NODEJS.md
          - Quickstart (Browser): sphere/docs/QUICKSTART-BROWSER.md
          - Quickstart (CLI): sphere/docs/QUICKSTART-CLI.md
          - Integration Guide: sphere/docs/INTEGRATION.md
          - L1 (ALPHA): sphere/docs/L1-ALPHA.md
          - Unicity ID: sphere/docs/UNICITY-ID.md
          - API Reference: sphere/docs/API.md
          - Providers & Config: sphere/docs/PROVIDERS-AND-CONFIG.md
          - Multi-Address: sphere/docs/MULTI-ADDRESS.md
          - Payments & Requests: sphere/docs/PAYMENT-REQUESTS.md
          - Market & Discovery: sphere/docs/MARKET.md
          - Atomic Swaps: sphere/docs/SWAP-PROTOCOL-V2.md
          - Connect (dApp / Wallet): sphere/docs/CONNECT.md
          - Direct Messages: sphere/docs/DIRECT-MESSAGES.md
          - Group Chat: sphere/docs/GROUP-CHAT.md
          - Identity & Crypto: sphere/docs/IDENTITY-CRYPTO.md
          - Token Backup (IPFS): sphere/docs/IPFS-STORAGE.md
          - Wallet Import / Export: sphere/docs/WALLET-IMPORT-EXPORT.md
  - AgentStack:
      - AstridOS:
          - Overview: agentstack/astrid.md
          - Kernel README: astrid/README.md
          - The Astrid Book: https://unicity-astrid.github.io/book/
          - The Contributor Handbook: https://unicity-astrid.github.io/handbook/
          - Configuration: astrid/docs/config.md
          - SDK Ergonomics: astrid/docs/sdk-ergonomics.md
          - Gateway Client: astrid/docs/gateway-client.md
          - Gateway Deployment: astrid/docs/gateway-deployment.md
          - Metrics: astrid/docs/metrics.md
          - Repositories:
              - astrid (kernel): https://github.com/unicity-astrid/astrid
              - sdk-rust: https://github.com/unicity-astrid/sdk-rust
              - sdk-js: https://github.com/unicity-astrid/sdk-js