mkdocs.yml

site_name: zoompilot wiki
site_description: >-
  Documentation for zoompilot, a Mazda-optimized fork of sunnypilot
  (openpilot). Install guides, feature reference, settings, safety, and
  technical design notes.
site_url: https://zoompilot-wiki.pages.dev
# The wiki's own repository. This is the only place its URL is written:
# the header icon and the "Edit this page" links are built from it, and
# the pages under docs/ send readers to those two links instead of
# carrying the URL. If the repo moves again, change repo_url and
# repo_name here and nothing else.
repo_url: https://github.com/zoompilot/wiki
repo_name: zoompilot/wiki
edit_uri: edit/main/docs/
copyright: >
  zoom-zoom-zoom · zoompilot is experimental software. You drive the car,
  follow the law, and carry all the risk.

theme:
  name: material
  # Zensical's new design. Switch to "classic" to get the exact old
  # Material for MkDocs look (same HTML, different stylesheet).
  variant: modern
  custom_dir: overrides
  logo: assets/brand/logo.svg
  favicon: assets/brand/favicon.svg
  # Same faces as zoompilot.ai: Inter for body, JetBrains Mono for code.
  # Audiowide (the site display face) is added in overrides/main.html and
  # used for the wordmark and the home-page hero.
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  palette:
    # Dark is the default. The first entry wins when no toggle was used
    # yet. Scheme names must stay "slate"/"default": Material's built-in
    # dark and light variables key off these names. Brand colors are
    # layered on in stylesheets/custom.css (docs/stylesheets/).
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.code.copy
    - content.code.select
    - content.tabs
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

plugins:
  - search
  # git-revision-date-localized was dropped in the Zensical move:
  # Zensical has no MkDocs plugin runtime yet (native support is
  # planned). The dates were CI-only and are gone for now.

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets:
      auto_append:
        - docs/includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde

extra_css:
  - stylesheets/custom.css
  # v2 components (lede, glance, steps, journey, next-step cards) and
  # reading rhythm; documented on community/style-guide.md
  - stylesheets/v2.css
  - stylesheets/print.css

extra_javascript:
  # site -> wiki generated data (npm run sync:wiki)
  - assets/steering-torque-data.js
  # wiki-side interactive features; each exits when its mount is absent
  - assets/js/torque-live.js
  - assets/js/settings-data.js
  - assets/js/settings-explorer.js
  - assets/js/device-switch.js
  - assets/js/troubleshoot-wizard.js
  - assets/js/vin-decoder.js

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/zoompilot/zoompilot
      name: zoompilot on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/jFWkHC2uhh
      name: zoompilot Discord
    - icon: material/web
      link: https://zoompilot.ai
      name: zoompilot.ai

nav:
  # v2 structure: seven tabs, each one page type for one reader.
  # Start here is a linear path (What is it -> car -> hardware -> safety
  # -> install -> first drive), then two "understand it" pages. safety.md
  # stays at the root on purpose: /safety/ is linked from the announce
  # bar on every page and from zoompilot.ai. Every moved page has a 301
  # in contrib/_redirects.
  - Home: index.md
  - Start here:
      - getting-started/index.md
      - getting-started/what-is-zoompilot.md
      - getting-started/supported-cars.md
      - getting-started/hardware.md
      - safety.md
      - getting-started/install.md
      - getting-started/first-drive.md
      - getting-started/how-it-works.md
      - getting-started/comparison.md
  - Features:
      - features/index.md
      - features/steering.md
      - features/smart-cruise.md
      - features/speed-limit-assist.md
      - features/icbm.md
      - features/sensor-readouts.md
      - features/alerts.md
      - features/alpha-longitudinal.md
  - Settings:
      - settings/index.md
      - settings/custom-tune.md
  - Help:
      - help/index.md
      - help/troubleshooting.md
      - help/ecu-reset.md
      - help/share-a-route.md
      - help/faq.md
      - help/glossary.md
      - help/privacy.md
  - Technical:
      # Technical pages mirror the zoompilot repo's docs/zoompilot and
      # carry no front matter (the site sync parses them); short nav
      # labels live here instead.
      - technical/index.md
      - Mazda lateral: technical/mazda-lateral.md
      - Lateral tune: technical/lateral-tune.md
      - technical/eps-swap.md
      - Mazda longitudinal: technical/mazda-longitudinal.md
      - Force offroad transitions: technical/force-offroad-alpha-transition.md
      - Cruise arbiter: technical/cruise-arbiter.md
      - ICBM design: technical/icbm.md
      - Curve & limit speed planning: technical/scc-curve-planning.md
      - Mazda fingerprinting: technical/mazda-fingerprinting.md
      - technical/rejected.md
      - Route library: technical/route-library.md
  - Community:
      - community/index.md
      - community/feedback.md
      - community/contribute.md
      - community/jetlink.md
      - community/roadmap.md
      - Releases: releases/changelog.md
      - community/about.md
      - community/style-guide.md
      - community/site-sync.md

validation:
  omitted_files: warn
  not_found: warn
  absolute_links: warn