mkdocs.yml

site_name: VEAF Mission Creation Tools
site_description: Tools and Lua scripts for dynamic DCS World missions
site_url: https://veaf.github.io/documentation/
repo_url: https://github.com/VEAF/VEAF-Mission-Creation-Tools
repo_name: VEAF/VEAF-Mission-Creation-Tools
docs_dir: doc
edit_uri: blob/develop/doc/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy

# POC: documentation chatbot widget (see poc/doc-chatbot/). Paths are relative to docs_dir (doc/).
extra_css:
  - assets/chatbot/veaf-chatbot.css
extra_javascript:
  - assets/chatbot/veaf-chatbot-config.js
  - assets/chatbot/veaf-chatbot.js

markdown_extensions:
  - toc:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      permalink: true
  # Lets headings declare a stable explicit id — `## Title {#stable-anchor}` — so deep
  # links (e.g. from generated mission.yaml comments) survive a heading reword and stay
  # identical across the FR/EN versions of a page (DOC-GUIDE-ANCHORS).
  - attr_list
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search:
      lang:
        - en
        - fr
  - i18n:
      docs_structure: suffix
      languages:
        - locale: fr
          default: true
          name: Français
          build: true
          nav_translations:
            Home: Accueil
            Pilot Guide: Guide Pilote
            Overview: Aperçu
            Guide: Guide
            Full Guide: Guide complet
            Mission Maker: Créateur de Mission
            Migration Guide: Guide de Migration
            Scripts: Scripts
            Developer: Développeur
            Capture a map's airbases: Récupérer les aérodromes d'une carte
            References: Références
            Tools CLI Reference: Référence CLI des outils
            Lua API Reference: Référence de l'API Lua
            Roadmap: Feuille de route
            Testing: Tests
            Aliases: Alias
            mission.yaml Reference: Référence mission.yaml
            Pipeline Reference: Référence Pipeline
        - locale: en
          name: English
          build: true

extra:
  version:
    provider: mike
    default: dev

nav:
  - Home: index.md
  - Pilot Guide:
    - Overview: pilot/README.md
    - Guide: pilot/GUIDE.md
    - Aliases: ALIASES.md
  - Mission Maker:
    - Overview: mission-maker/README.md
    - Guide: mission-maker/GUIDE.md
    - Migration Guide: mission-maker/MIGRATION_GUIDE.md
    - Adopt a third-party mission: mission-maker/CONVERT_OTHER.md
    - Foothold moulinette: mission-maker/FOOTHOLD.md
    - AI assistant — install: mission-maker/AI_ASSISTANT_INSTALL.md
    - AI assistant — action catalogue: mission-maker/AI_ASSISTANT_CATALOG.md
    - Aliases: ALIASES.md
    - Scripts:
      - Overview: mission-maker/scripts/README.md
      - veafAirWaves: mission-maker/scripts/veafAirWaves.md
      - veafAirbases: mission-maker/scripts/veafAirbases.md
      - veafAssets: mission-maker/scripts/veafAssets.md
      - veafAssist: mission-maker/scripts/veafAssist.md
      - veafCarrierOperations: mission-maker/scripts/veafCarrierOperations.md
      - veafCasMission: mission-maker/scripts/veafCasMission.md
      - veafCombatZone: mission-maker/scripts/veafCombatZone.md
      - veafGrass: mission-maker/scripts/veafGrass.md
      - veafInterpreter: mission-maker/scripts/veafInterpreter.md
      - veafMissileGuardian: mission-maker/scripts/veafMissileGuardian.md
      - veafMove: mission-maker/scripts/veafMove.md
      - veafNamedPoints: mission-maker/scripts/veafNamedPoints.md
      - veafQraManager: mission-maker/scripts/veafQraManager.md
      - veafRadio: mission-maker/scripts/veafRadio.md
      - veafSanctuary: mission-maker/scripts/veafSanctuary.md
      - veafSecurity: mission-maker/scripts/veafSecurity.md
      - veafServerHook: mission-maker/scripts/veafServerHook.md
      - veafShortcuts: mission-maker/scripts/veafShortcuts.md
      - veafSkynetIadsHelper: mission-maker/scripts/veafSkynetIadsHelper.md
      - veafSpawn: mission-maker/scripts/veafSpawn.md
      - veafTransportMission: mission-maker/scripts/veafTransportMission.md
      - veafWeather: mission-maker/scripts/veafWeather.md
  - Developer:
    - Overview: developer/README.md
    - Guide: developer/GUIDE.md
    - DCS data generators: developer/dcs-data.md
    - Capture a map's airbases: developer/capture-airbases.md
    - Mission editing MCP: developer/mission-editing-mcp.md
    - Radio preset projection: developer/radio-preset-projection.md
    - Export JSON contract: developer/export-json-contract.md
    - Smoke harness (in-DCS): developer/smoke-harness.md
    - Testing: TESTING.md
  - References:
    - mission.yaml Reference: MISSION_YAML_REFERENCE.md
    - Pipeline Reference: PIPELINE_REFERENCE.md
    - DCS Radio Specs: mission-maker/dcs-radio-specs.md
    - Lua API Reference: LUA_API_REFERENCE.md
    - Tools CLI Reference: TOOLS_REFERENCE.md
    - Roadmap: ROADMAP.md