mkdocs.yml

site_name: Fleet Runner
site_description: A shelf of old phones, turned into a device lab you can send work to.
site_url: https://addisdev.github.io/fleet-runner/
repo_url: https://github.com/addisdev/fleet-runner
repo_name: addisdev/fleet-runner
edit_uri: edit/develop/docs/
copyright: MIT licensed

theme:
  name: material
  logo: img/mark-mono.svg
  favicon: img/mark.svg
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.tabs.link
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    # The two colours are the mark's: charcoal #1C2025 and amber #E3A44A.
    # Material's palette is a fixed set of names, so the accent is the nearest
    # one and the exact hexes are pinned in docs/css/brand.css.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# docs/figures/ holds the SOURCES the figures are rendered from — one HTML file
# per figure, the brand stylesheet they share, the self-hosted fonts, and the
# shelf photograph. They are inputs to `npm run assets`, not pages, and
# publishing them shipped the figure markup into the site: the link check
# caught it, because a figure that is skipped until its photograph exists
# carries an <img> pointing at a file that is not there yet.
#
# The directory is `figures/` and not `assets/` because Material writes its own
# theme stylesheets to site/assets/, and excluding `assets/` took those with it
# — every page then linked a stylesheet the build no longer shipped.
exclude_docs: |
  figures/

extra_css:
  - css/brand.css

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  # The cookbook includes the example job specs verbatim from collector/, which
  # `npm test` validates against job.schema.json. Copying them into the page
  # instead would mean the docs could drift from what the collector accepts,
  # which is the whole failure this guards against.
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true

nav:
  - Home: index.md
  - Get started: getting-started.md
  - Install:
      - Overview: install/index.md
      - macOS: install/macos.md
      - Windows: install/windows.md
      - Linux: install/linux.md
      - Docker: install/docker.md
      - Adding devices: install/devices.md
  - Concepts: concepts.md
  - Dashboard: dashboard.md
  - Workloads:
      - Overview: workloads/index.md
      - On the device: workloads/device.md
      - On a host: workloads/host.md
      - On a machine: workloads/machine.md
  - Exploratory QA:
      - Overview: explore/index.md
      - Try it on a laptop: explore/quickstart.md
      - How a night works: explore/how-it-works.md
      - Mission cards: explore/missions.md
      - The job spec: explore/job.md
      - Models and the gateway: explore/models.md
      - Devices: explore/surfaces.md
      - The leash: explore/safety.md
      - Findings and verdicts: explore/findings.md
      - Measuring a model: explore/measuring.md
      - Troubleshooting: explore/troubleshooting.md
      - Internals: explore/internals.md
      - Running it on ultra: deploy/explore-on-ultra.md
  - Integration:
      - Wire in your app: integration/index.md
      - Your first job: integration/first-job.md
      - Publish on merge: integration/publish-on-merge.md
      - Add your app: integration/add-your-app.md
      - Add a workload: integration/add-a-workload.md
      - Cookbook: integration/cookbook.md
  - AI agents and automation: agents.md
  - Reference:
      - The protocol: protocol.md
      - Platforms: platforms.md
      - Writing a runner: writing-a-runner.md
      - HTTP API: api.md
  - Deploy:
      - Overview: deploy/index.md
      - Headless hosts: deploy/headless.md
      - Networking: deploy/networking.md
      - The iOS executor: deploy/ios-executor.md
      - Alerts: deploy/alerts.md
      - Authentication and MCP gateway: deploy/auth.md
      - This lab: lab.md
  - Brand: brand.md
  - History:
      - Overview: history/index.md
      - Dashboard plan: history/dashboard-plan.md
      - UI test plan: history/ui-test-plan.md
      - iOS nightly suites: history/ios-nightly-suites.md