mkdocs.yml

site_name: Water Linked Documentation
site_url: https://docs.waterlinked.com
repo_url: https://github.com/waterlinked/docs
edit_uri: ""
theme:
  name: material

  theme_dir: docstheme/material
  logo: img/waterlinked_logo.png
  favicon: img/favicon_water_linked.ico
  font:
    text: Open Sans
  palette:
    # Light mode — brand colors are defined in css/extra.css (primary/accent: custom)
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - content.heading.permalinks
    - content.code.copy
    - navigation.tabs
    - search.suggest
    - search.highlight
    - search.share
  icon:
    link: material/link-variant 

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/waterlinked/
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/waterlinked/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCZFmOcapjyWgEnS_l6JgxQg/

markdown_extensions:
  - toc:
      permalink: "🔗"
  - admonition
  - def_list
  - footnotes
  - meta
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  
extra_css:
  - css/extra.css
nav:
  - Home: index.md

  - Sonar 3D 15:
      - Overview: sonar-3d/sonar-3d-15-introduction.md
      - Get started Quickstart Guide: sonar-3d/sonar-3d-15-quickstart.md

      - Install and connect:
          - Dimensions & FOV: sonar-3d/sonar-3d-15-mechanical.md
          - Electrical & LED: sonar-3d/sonar-3d-15-electrical.md
          - Network Setup: sonar-3d/sonar-3d-15-networking.md

      - Operate the device:
          - GUI: sonar-3d/sonar-3d-15-gui.md
          - Settings: sonar-3d/sonar-3d-15-config.md
          - Replay Sonar Data: sonar-3d/sonar-replay.md
          - Time: sonar-3d/sonar-3d-15-time.md
          - API: sonar-3d/sonar-3d-15-api.md
          - Software update: sonar-3d/sonar-3d-15-software-update.md

      - Integrate with specific ROV:
          - DeepTrekker Pivot: sonar-3d/sonar-3d-15-deep-trekker-rov.md
          - Blueye X3: sonar-3d/sonar-3d-15-blueye-rov.md
          - BlueROV2: sonar-3d/sonar-3d-15-bluerov-integration.md
          - Chasing M2 PRO MAX: sonar-3d/sonar-3d-15-chasing-rov.md

      - Troubleshooting:
          - FAQ: sonar-3d/sonar-3d-15-faq.md
          - Diagnostic log: sonar-3d/sonar-3d-15-diagnostic-log.md

      - Resources:
          - Links to Resources: sonar-3d/sonar-3d-15-resources.md
          - Software Changelog: sonar-3d/sonar-3d-15-software-changelog.md

  - Underwater GPS:
      - G2:
          - Introduction: underwater-gps/introduction.md
          - Quickstart: underwater-gps/quickstart.md
          - Reference frames: underwater-gps/reference-frames.md
          - Interface:
             - GUI: underwater-gps/interface/ugps-gui.md
             - LED: underwater-gps/interface/ugps-led.md
             - Wiring: underwater-gps/interface/ugps-wiring.md
             - Warnings: underwater-gps/interface/warnings.md
          - Hardware setup: 
              - System setup: underwater-gps/ugps-sys-setup.md
              - Components:
                  - Power supply: underwater-gps/power-supply.md
                  - Topside: underwater-gps/ugps-topside.md
                  - Baseline:
                      - Antenna: underwater-gps/antenna.md
                      - Receiver-D1: underwater-gps/receiver-d1.md
                  - Locators:
                      - Locator-A1: underwater-gps/locators/locator-a1.md
                      - Locator-D1: underwater-gps/locators/locator-d1.md
                      - Locator-U1: underwater-gps/locators/locator-u1.md
          - System configurations: underwater-gps/ugps-sysconfig.md
          - Networking: underwater-gps/network-settings.md
          - Integration:
              - API: underwater-gps/integration/api.md
              - External compass: underwater-gps/integration/external-gps.md
              - BlueROV2 integration:
                  - Overview: underwater-gps/integration/bluerov-integration.md
                  - BlueROV2 & Locator-A1: underwater-gps/integration/bluerov-integration-a1.md
                  - BlueROV2 & Locator-U1: underwater-gps/integration/bluerov-integration-u1.md
          - Software updates: underwater-gps/sw-update.md
          - Underwater GPS FAQ: underwater-gps/ugps-faq.md
      - Explorer Kit (retired):
          - Quickstart: explorer-kit/quickstart.md
          - Introduction: explorer-kit/introduction.md
          - Warnings: explorer-kit/warnings.md
          - Power supply: explorer-kit/power-supply.md
          - Network settings: explorer-kit/network-settings.md
          - Hardware: explorer-kit/hardware.md
          - Master-D1: explorer-kit/master-d1.md
          - Receiver-D1: explorer-kit/receiver-d1.md
          - Locators:
              - Locator-A1: explorer-kit/locators/locator-a1.md
              - Locator-D1: explorer-kit/locators/locator-d1.md
              - Locator-S1 (obsolete): explorer-kit/locators/locator-s1.md
              - Locator-U1: explorer-kit/locators/locator-u1.md
          - GUI:
              - Position: explorer-kit/gui/position.md
              - Receivers: explorer-kit/gui/receivers.md
              - Settings: explorer-kit/gui/settings.md
              - Diagnostic: explorer-kit/gui/diagnostic.md
              - API: explorer-kit/gui/api.md
          - Software updates: explorer-kit/upgrader.md

  - DVL:
      - Overview: dvl/overview.md
      - Get started Quickstart guide: dvl/quickstart.md

      - Models:
          - A50: dvl/dvl-a50.md
          - A100: dvl/dvl-a100.md
          - A125: dvl/dvl-a125.md
          - A250: dvl/dvl-a250.md

      - Install and connect:
          - Installation: dvl/installation.md
          - Electrical: dvl/electrical.md
          - Network setup: dvl/networking.md

      - Operate the device:
          - Axes: dvl/axes.md
          - Range mode: dvl/range-mode.md
          - Water tracking: dvl/water-tracking.md
          - Time: dvl/time.md
          - Settings and configuration: dvl/configuration.md
          - Dead reckoning: dvl/dead-reckoning.md
          - Software updates: dvl/sw-update.md
          - Changelog:
              - DVL A50/A125 changelog: dvl/dvl-a50_a125-changelog.md
              - DVL A100/A250 changelog: dvl/dvl-a250_a100-changelog.md
          - Web GUI:
              - DVL A50/A125 web GUI: dvl/dvl-a50_a125-gui.md
              - DVL A100/A250 web GUI: dvl/dvl-a250_a100-gui.md

      - Integration:
          - Integration overview: dvl/integration.md
          - TCP JSON API:
              - A50/A125: dvl/dvl-json-protocol.md
              - A100/A250: dvl/dvl-a250_a100-json-protocol.md
          - Serial protocol:
              - A50/A125: dvl/dvl-serial-protocol.md
              - A100/A250: dvl/dvl-a250_a100-serial-protocol.md
          - PD formats: dvl/dvl-pd-formats.md
          - Triggering and synchronization: dvl/dvl-triggering.md
          - Software resources: dvl/software-resources.md
          - DVL for BlueROV2: dvl/bluerov-integration.md
          - DVL with UGPS for BlueROV2: dvl/bluerov-integration-dvl-ugps.md

      - Troubleshooting: 
          - Diagnostic log: dvl/diagnostic-log.md
          - How to diagnose: dvl/how-to-diagnose.md
          - Support package checklist: dvl/support-package-checklist.md
          - FAQ: dvl/faq.md

  - Modem:
      - Modem-M16:
          - Introduction: modem-m16/modem-m16.md
          - Quickstart: modem-m16/modem-m16-quickstart.md
          - Interface:
            - Wiring interface: modem-m16/modem-m16-wiring.md
            - GUI: modem-m16/modem-m16-gui.md
          - Integration:
            - Interface overview: modem-m16/modem-m16-integration.md
            - Protocol: modem-m16/modem-m16-protocol.md
            - Diagnostic report structure: modem-m16/modem-m16-diagnostic-report.md
          - M16 FAQ: modem-m16/modem-m16-faq.md
      - Modem-M64 (retired):
          - Introduction: modem-m64/modem-m64.md
          - Protocol: modem-m64/modem-m64-protocol.md

  - I/O interface cards: 
      - Revision 2: io-interface-cards/io-interface-rev2.md
      - Revision 3: io-interface-cards/io-interface-rev3.md
      - Revision 4: io-interface-cards/io-interface-rev4.md
      - Revision 6: io-interface-cards/io-interface-rev6.md


copyright: © Water Linked 2018-2026