mkdocs.yml

site_name: HiveMind Documentation
site_url: https://jarbashivemind.github.io/HiveMind-community-docs/
site_description: >-
  The official manual for HiveMind — the open-source protocol that connects
  lightweight satellite devices to a central hivemind-core server over an encrypted mesh.
repo_url: https://github.com/JarbasHiveMind
repo_name: JarbasHiveMind

# With `mkdocs build --strict`, these promote to hard errors — so a broken internal
# link, a dead anchor, or a page missing from the nav fails CI.
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - About: about.md
  - Quick Start: quickstart.md
  - FAQ: faq.md
  - Core Concepts:
    - concepts/index.md
    - Mesh Topology: concepts/mesh.md
    - Nested Hives: concepts/nested-hives.md
    - Protocol & Message Types: concepts/protocol.md
    - Security & Permissions: concepts/security.md
    - Database Backends: concepts/databases.md
    - Auto Discovery: concepts/discovery.md
    - Plugin Architecture: concepts/plugins.md

  - Satellites:
    - satellites/index.md
    - HiveMind CLI: satellites/cli.md
    - Mic Satellite: satellites/mic-satellite.md
    - Voice Relay: satellites/voice-relay.md
    - Voice Satellite: satellites/voice-sat.md
    - WebSpeech Browser: satellites/webspeech.md
    - Microcontrollers (ESP32): satellites/microcontrollers.md

  - Self-Hosting:
    - server/index.md
    - Admin Panel: server/admin-panel.md
    - OVOS Skills Server: server/ovos-server.md
    - Persona Server (LLM): server/persona-server.md
    - A2A Server (Agents): server/a2a-server.md
    - Transports: server/transports.md
    - Audio Binary Protocol: server/audio-binary-protocol.md
    - Docker Deployment: server/docker.md
    - Operations: server/operations.md

  - Integrations:
    - integrations/index.md
    - Home Assistant: integrations/home-assistant.md
    - Media Player: integrations/media-player.md
    - Matrix: integrations/matrix.md
    - DeltaChat: integrations/deltachat.md
    - Mattermost: integrations/mattermost.md
    - Twitch: integrations/twitch.md
    - HackChat: integrations/hackchat.md

  - Developer Guide:
    - developers/index.md
    - Client Library: developers/client-library.md
    - Protocol Specification: developers/protocol-spec.md
    - Writing Plugins: developers/writing-plugins.md
    - Testing: developers/testing.md

  - Reference:
    - reference/index.md
    - CLI Commands: reference/cli.md
    - Message Types: reference/message-types.md
    - Configuration: reference/config.md
    - Glossary: reference/glossary.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/JarbasHiveMind
      name: HiveMind on GitHub
    - icon: simple/matrix
      link: https://matrix.to/#/#jarbashivemind:matrix.org
      name: HiveMind Matrix chat
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCYoV5kxp2zrH6pnoqVZpKSA/
      name: HiveMind on YouTube

extra_javascript:
  - javascripts/analytics.js